Skip to main content
Execute Script As Event

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.

Path Parameters

cRMScriptId
integer<int32>
required

The id of the CRMScript to execute

Body

The EventData instance sent to the crmscript with input values

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.

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.