Skip to main content
Get Trigger Script By Unique Id

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

triggerScriptUniqueId
string
required

The unique id of the CRMScript to validate

Response

OK

CRM Trigger Script - The script runs when a given event fires. Carrier object for TriggerScriptEntity. Services for the TriggerScriptEntity Carrier is available from the CRMScript Agent.

ScreenChooserId
integer<int32>

Primary key

Name
string

Optional description of what this script is used for.

ScreenType
enum<string>

Event id that triggers script. See EventHandlerType enum.

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
Enabled
boolean

Whether this screen chooser is enabled or not

UniqueIdentifier
string

Global unique identifier, accross customers/tenants

Source
string

The CRMscript code for this event handler

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

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.