Skip to main content

Methods

ChatAfterSaveNewMessage

(403) Called after a chat message is saved.
Input valuesThe message has a list of clickable options. Options are as JSON array in specialParam.
Example:

ChatBeforeSaveNewMessage

(402) Called before a chat message is saved.
Input valuesThe message has a list of clickable options. Options are as JSON array in specialParam.Output values <table><table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td>chatMessage.message</td><td></td></tr><tr><td>chatMessage.specialType</td><td>Special type of message</td></tr><tr>
Example:

ChatNewSession

Fires when a new chat session starts. Corresponds to the webhook chatsession.created event.
Input values
Example:

ChatSessionChangedStatus

(401) Called when session changes status. Equivalent to webhook chatsession.changed.
Input values
Example:

CompactModeInjection

(200) Add custom stuff to our CompactMode client.
Input valuesnoneOutput values
Example:

CustomerCenterAuthentication

(210) Called when customer logs into Customer centre.
Input valuesOutput values
Example:

CustomerSetSubscriptions

(302) Called when setting subscriptions from Manage subscription page.
Input values
Example:

DbiTaskFailed

(301) Called when a DBI task fails to execute successfully.
Input values
Example:

ImportMailAfterProcessing

(304) Called after email is processed by email filters and save to the system.
Input valuesIn addition, any variables set by the email filter are also available with the name specified in the email filter.
Example:

ImportMailBeforeProcessing

There are several variables available in this context.
  • To get a variable:<code>getVariable(“xxx”)</code>
  • To set a variable:<code>setVariable(“xxx”, <value>)</code>, where <value> is a valid value for the field you are trying to set.
Input valuesOutput values
Example:
(113) Runs when the main menu is rendered.
Example:

NewNotifyTicketFromForm

(105) Called when a new ticket was created from a form.
Input values
Example:

NewTicket

(100) Runs when a new ticket is created.
Input values
Example:

NewTicketFromCustomerCenter

(101) Called when a new ticket is created and saved from Customer center
Input values
Example:

NewTicketFromCustomerCenterBeforeSave

(103) Called before a new ticket is created and saved from Customer center.
Input valuesOutput values
Example:

NewTicketFromEmail

(102) Runs after ImportMailAfterProcessing (304) if ticket did not exist.
Input values
Example:

NewTicketFromForm

(106) Called when a form submission creates a new ticket.
Input values
Example:
(104) Called when a mailing link was clicked and mailing specifies link tracking.
Input values
Example:

SalesAfterSaveAppointment

(1101) Called after an appointment is saved. EventData contains all variables passed by datahandler in the Sales client. It is also possible to create and pass custom variables from BeforeSave event trigger.
Input values
Example:

SalesAfterSaveContact

(1105) Called after a contact is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveDocument

(1104) Called after a document is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveCustomObject

(1117) Called after a Custom object is saved. EventData contains all variables passed by datahandler in the Sales client.
Note: This trigger is only supported in New Service with CustomObject FeatureToggleInput values
Example:

SalesAfterSavePerson

(1106) Called after a person is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveProject

(1109) Called after a project is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveProjectMember

(1011) Called after project member is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveQuote

(1103) Called after an quote is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveQuoteLine

(1113) Called after an quote line is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveAcceptQuote

(1114) Called after saving a quote approval. EventData contains all variables passed by datahandler in the Sales client.
This trigger is only available as CRMScript trigger.Input values
Example:

SalesAfterSaveRejectQuote

(1115) Called after saving quote rejection. EventData contains all variables passed by datahandler in the Sales client.
This trigger is only available as CRMScript trigger.Input values
Example:

SalesAfterSaveRelation

(1107) Called after a relation is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveSale

(1108)Called after a sale is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveSelection

(1110) Called after selection is saved. EventData contains all variables passed by datahandler in the Sales client.
Example:

SalesAfterSaveSelectionMember

(1112) Called after selection member is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveStakeholder

(1002) Called after a sale stakeholder is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesAfterSaveTicket

(1116) Called after a ticket is saved. EventData contains all variables passed by datahandler in the Sales client.
Note: This trigger is supported only in New Service Input values
Example:

SalesBeforeSaveAppointment

(1001) Called before an appointment is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveContact

(1005) Called before a contact is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveCustomObject

(1018) Called before a Custom object is saved. EventData contains all variables passed by datahandler in the Sales client.
Note: This trigger is only supported in New Service with CustomObject FeatureToggleInput values
Example:

SalesBeforeSaveDocument

(1004) Called before an document is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSavePerson

(1006) Called before a person is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveProject

(1009) Called before a project is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveProjectMember

(1011) Called before project member is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveQuote

(1003) Called before an quote is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveQuoteLine

(1013) Called before an quote line is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveAcceptQuote

(1014) Called before saving quote approval. EventData contains all variables passed by datahandler in the Sales client.
This trigger is only available as CRMScript trigger.Input values
Example:

SalesBeforeSaveRejectQuote

(1015) Called before saving quote rejection. EventData contains all variables passed by datahandler in the Sales client.
This trigger is only available as CRMScript trigger.Input values
Example:

SalesBeforeSaveRelation

(1007) Called before a relation is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveSale

(1008) Called before a sale is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveSelection

(1010) Called before selection is saved. EventData contains all variables passed by datahandler in the Sales client.
Example:

SalesBeforeSaveSelectionMember

(1012) Called before selection member is saved. EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveStakeholder

(1002) Called before a sale stakeholder is saved.EventData contains all variables passed by datahandler in the Sales client.
Input values
Example:

SalesBeforeSaveTicket

(1016) Called before a ticket is saved. EventData contains all variables passed by datahandler in the Sales client.
Note: This trigger is only supported in New Service Input values
Example:

SalesLoadCustomObject

(1017) Called before a Custom object screen is loaded. EventData contains all variables passed by datahandler in the Sales client. Possible to manipulate field values by using setOutputValue()
Note: This trigger is only supported in New Service with CustomObject FeatureToggleInput values
Example:

SalesLoadTicket

(1020) Called before a ticket screen is loaded. EventData contains all variables passed by datahandler in the Sales client. Possible to manipulate field values by using setOutputValue()
Note: This trigger is only supported in New ServiceInput values
Example:

SalesLoadTicketMessage

(1021) Called before a ticket message screen is loaded. EventData contains all variables passed by datahandler in the Sales client. Possible to manipulate field values by using setOutputValue()
Note: This trigger is only supported in New Service Input values
Example:

SalesSplitTicket

(1019) Called when performing Split Request. EventData contains all variables passed by datahandler in the Sales client. Possible to manipulate field values by using setOutputValue()
Note: This trigger is only supported in New ServiceInput values
Example:

ScheduledTaskFailed

(300) Runs after scheduled task failed
Input values
Example:

ServiceScreenAddMessageAfterSubmit

(703) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenAddMessageBeforeSubmit

(603) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenAddMessageLoad

(503) Called when screen is constructed, useful for setting default values into HTML elements
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditCompanyAfterSubmit

(708) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditCompanyBeforeSubmit

(608) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditCompanyLoad

(508) Runs for <code>HtmlPage.lang_ticket_newCompany</code> screen. Called when screen is constructed, useful for setting default values into HTML elements
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditCustomerAfterSubmit

(706) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditCustomerBeforeSubmit

(606) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditCustomerLoad

(506) Runs for <code>HtmlPage.lang_ticket_editCustomer</code> Called when screen is constructed, useful for setting default values into HTML elements
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditExtraTableAfterSubmit

(710) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditExtraTableBeforeSubmit

(610) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditExtraTableLoad

(510) Called when screen is constructed, useful for setting default values into HTML elements.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditTicketAfterSubmit

(704) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditTicketBeforeSubmit

(604) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenEditTicketLoad

(504) Called when screen is constructed, useful for setting default values into HTML elements
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenForwardAfterSubmit

(709) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenForwardBeforeSubmit

(609) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenForwardLoad

(509) Runs for <code>HtmlPage.forward</code> event. Called when screen is constructed, useful for setting default values into HTML elements.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenListTicketMessagesAfterSubmit

(702) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenListTicketMessagesBeforeSubmit

(602) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenListTicketMessagesLoad

(502) Called when screen is constructed, useful for setting default values into HTML elements.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenNewQuickTicketAfterSubmit

(701) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenNewQuickTicketBeforeSubmit

(601) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenNewQuickTicketLoad

(501) Called when screen is constructed, useful for setting default values into HTML elements.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenNewTicketAfterSubmit

(700) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenNewTicketBeforeSubmit

(600) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenNewTicketLoad

(500) Called when screen is constructed, useful for setting default values into HTML elements.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenViewCompanyAfterSubmit

(707) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenViewCompanyBeforeSubmit

(607) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenViewCompanyLoad

(507) Called when screen is constructed, useful for setting default values into HTML elements.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenViewCustomerAfterSubmit

(705) Called after screen is submitted and values are saved, useful for performing after processing.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenViewCustomerBeforeSubmit

(605) Called before screen is submitted and values are saved, useful for validations with blocking of save.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

ServiceScreenViewCustomerLoad

(505) Called when screen is constructed, useful for setting default values into HTML elements.
Input valuesAll HTML elements in the screen are added to the input values.
Example:

TicketActivated

(113) Runs when ticket is saved and status changed from postponed to active.
Input values
Example:

TicketChangedCategory

(141) Runs when a ticket is saved and the ticket category changes ID.
Input values
Example:

TicketChangedOwnedBy

(142) Runs when a ticket is saved and the owner changed.
Input values
Example:

TicketChangedPrimaryCustomer

(143) Runs when a ticket is saved and the customer ID changes.
Input values
Example:

TicketChangedPriority

(140) Runs when a ticket is saved and priority changed.
Input values
Example:

TicketChangedSlevel

(145) Runs when a ticket is saved and the security level changed.
Input values
Example:

TicketChangedTicketStatus

(144) Runs when a ticket is saved and status changed. If user-defined statuses are present in solution available values will differ from below.
Input values
Example:

TicketClosed

(110) Runs when a ticket is saved and the status changes to closed.
Input values
Example:

TicketDeleted

(112) Runs when a ticket is saved and the status changes to deleted.
Input values
Example:

TicketExternalMessageAdded

(152) Called for all external messages added to a ticket, following a call to the TicketMessageAdded trigger.
Input values
Example:

TicketInternalMessageAdded

(151) Called for all internal messages added to a ticket, following a call to the TicketMessageAdded trigger.
Input values
Example:

TicketMessageAdded

(150) Called for all messages added to a ticket, followed by call to either <code>TicketInternalMessageAdded</code> or <code>TicketExternalMessageAdded</code> trigger.
Input values
Example:

TicketMessageSentimentCalculated

(153) Runs when a new sentiment is calculated.
Input values
Example:

TicketPostponed

(111) Runs when a ticket is saved and the status changed to postponed.
Input values
Example:

TicketReopened

(120) Runs when a ticket is saved and the status changed from closed to active.
Input values
Example:

TicketReopenedFromCustomerCenter

(121) Called when a ticket is reopened from Customer center.
Input values
Example:

TicketReopenedFromEmail

(122) Runs after ImportMailAfterProcessing (304) if ticket existed before.
Input values
Example:

TicketSave

Called when a ticket is being saved.
Input values
Example:

OutboxItemCreated

Called when an outbox item is being created (outbound email or SMS).
See also tutorial.
Example: