Skip to main content
Execute Script As Event

Authorizations

Authorization
string
header
required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization
string
header
required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit
Authorization URL
https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

CRMScriptId, EventData

ExecuteScriptAsEvent: Execute a CRMScript with event data as input. Returns event data with output variable values.

CRMScriptId
integer<int32>
EventData
object

EventData containing data related to event handlers Carrier object for EventData. Services for the EventData Carrier is available from the CustomerService Agent.

Response

OK

EventData containing data related to event handlers Carrier object for EventData. Services for the EventData Carrier is available from the CustomerService Agent.

Type
enum<string>

The type of event we are triggered by

Available options:
Unknown,
NewTicket,
NewTicketFromCustomerCenter,
NewTicketFromEmail,
NewTicketFromCustomerCenterBeforeSave,
NewTicketFromSpmLink,
NewNotifyTicketFromForm,
NewTicketFromForm,
TicketSave,
TicketClosed,
TicketPostponed,
TicketDeleted,
TicketActivated,
TicketReopened,
TicketReopenedFromCustomerCenter,
TicketReopenedFromEmail,
TicketChangedPriority,
TicketChangedCategory,
TicketChangedOwnedBy,
TicketChangedPrimaryCustomer,
TicketChangedTicketStatus,
TicketChangedSlevel,
TicketMessageAdded,
TicketInternalMessageAdded,
TicketExternalMessageAdded,
TicketMessageSentimentCalculated,
CompactModeInjection,
CustomerCenterAuthentication,
ScheduledTaskFailed,
DbiTaskFailed,
CustomerSetSubscriptions,
ImportMailBeforeProcessing,
ImportMailAfterProcessing,
MainMenu,
ChatNewSession,
ChatSessionChangedStatus,
ChatBeforeSaveNewMessage,
ChatAfterSaveNewMessage,
ServiceScreenNewTicketLoad,
ServiceScreenNewQuickTicketLoad,
ServiceScreenListTicketMessagesLoad,
ServiceScreenAddMessageLoad,
ServiceScreenEditTicketLoad,
ServiceScreenViewCustomerLoad,
ServiceScreenEditCustomerLoad,
ServiceScreenViewCompanyLoad,
ServiceScreenEditCompanyLoad,
ServiceScreenForwardLoad,
ServiceScreenEditExtraTableLoad,
ServiceScreenNewTicketBeforeSubmit,
ServiceScreenNewQuickTicketBeforeSubmit,
ServiceScreenListTicketMessagesBeforeSubmit,
ServiceScreenAddMessageBeforeSubmit,
ServiceScreenEditTicketBeforeSubmit,
ServiceScreenViewCustomerBeforeSubmit,
ServiceScreenEditCustomerBeforeSubmit,
ServiceScreenViewCompanyBeforeSubmit,
ServiceScreenEditCompanyBeforeSubmit,
ServiceScreenForwardBeforeSubmit,
ServiceScreenEditExtraTableBeforeSubmit,
ServiceScreenNewTicketAfterSubmit,
ServiceScreenNewQuickTicketAfterSubmit,
ServiceScreenListTicketMessagesAfterSubmit,
ServiceScreenAddMessageAfterSubmit,
ServiceScreenEditTicketAfterSubmit,
ServiceScreenViewCustomerAfterSubmit,
ServiceScreenEditCustomerAfterSubmit,
ServiceScreenViewCompanyAfterSubmit,
ServiceScreenEditCompanyAfterSubmit,
ServiceScreenForwardAfterSubmit,
ServiceScreenEditExtraTableAfterSubmit,
SalesBeforeSaveAppointment,
SalesBeforeSaveStakeholder,
SalesBeforeSaveQuote,
SalesBeforeSaveDocument,
SalesBeforeSaveContact,
SalesBeforeSavePerson,
SalesBeforeSaveRelation,
SalesBeforeSaveSale,
SalesBeforeSaveProject,
SalesBeforeSaveSelection,
SalesBeforeSaveProjectMember,
SalesBeforeSaveSelectionMember,
SalesBeforeSaveQuoteLine,
SalesBeforeSaveApproveQuote,
SalesBeforeSaveRejectQuote,
SalesBeforeSaveTicket,
SalesLoadCustomObject,
SalesBeforeSaveCustomObject,
SalesAfterSaveAppointment,
SalesAfterSaveStakeholder,
SalesAfterSaveQuote,
SalesAfterSaveDocument,
SalesAfterSaveContact,
SalesAfterSavePerson,
SalesAfterSaveRelation,
SalesAfterSaveSale,
SalesAfterSaveProject,
SalesAfterSaveSelection,
SalesAfterSaveProjectMember,
SalesAfterSaveSelectionMember,
SalesAfterSaveQuoteLine,
SalesAfterSaveApproveQuote,
SalesAfterSaveRejectQuote,
SalesAfterSaveTicket,
SalesAfterSaveCustomObject,
SalesSplitTicket,
SalesLoadTicket,
SalesLoadTicketMessage
InputValues
object

Environment values sent to the event handler

BlockExecution
boolean

Whether the context should stop what it is doing, e.g. saving a sale

NavigateTo
string

Where the context should naviate afterwards

Message
string

A message to be presented to the user

ShowDialog
string

JSON structure of dialog to show

OutputValues
object

Values sent back to the environment from the event handler

StateValues
object

Values kept between event handlers

Exception
string

String containing error message from handler system if it failed

ParserValues
object

Parser values sent to the event handler

CgiVariables
object

Cgi variables sent by some events

CgiContent
string

The Cgi content/body, sent by some events

Headers
object

Incoming headers if sent by the context which the script is executed from

TraceExecution
boolean

If true, then the execution will be traced

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.