Back to SuperOfficeExecute a CRMScript with event data as input.
Returns event data with output variable values.
## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.
Input
type: object
properties:
parameters:
type: object
properties:
cRMScriptUniqueId:
type: string
description: The unique id of the CRMScript to execute
eventData:
description: "EventData containing data related to event handlers\r\n<para />\r\nCarrier object for EventData.\r\nServices for the EventData Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ICustomerServiceAgent\">CustomerService Agent</see>."
type: object
properties:
Type:
description: The type of event we are triggered by
enum:
- 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
- SalesAfterSaveAppointment
- SalesAfterSaveStakeholder
- SalesAfterSaveQuote
- SalesAfterSaveDocument
- SalesAfterSaveContact
- SalesAfterSavePerson
- SalesAfterSaveRelation
- SalesAfterSaveSale
- SalesAfterSaveProject
- SalesAfterSaveSelection
- SalesAfterSaveProjectMember
- SalesAfterSaveSelectionMember
- SalesAfterSaveQuoteLine
- SalesAfterSaveApproveQuote
- SalesAfterSaveRejectQuote
- SalesAfterSaveTicket
type: string
InputValues:
description: Environment values sent to the event handler
type: object
additionalProperties:
type: string
BlockExecution:
description: >-
Whether the context should stop what it is doing, e.g. saving a
sale
type: boolean
NavigateTo:
description: Where the context should naviate afterwards
type: string
Message:
description: A message to be presented to the user
type: string
ShowDialog:
description: JSON structure of dialog to show
type: string
OutputValues:
description: Values sent back to the environment from the event handler
type: object
additionalProperties:
type: string
StateValues:
description: Values kept between event handlers
type: object
additionalProperties:
type: string
Exception:
description: String containing error message from handler system if it failed
type: string
TableRight:
type: object
properties:
Mask:
enum:
- None
- Select
- Update
- Insert
- Delete
- Filtering
- RestrictedUpdate
- Unused1
- Uninitialized
- FULL
- WRITE
- URU
- UDR
- UR
- URI
- R
- RI
- RF
- F
- FI
type: string
Reason:
type: string
FieldProperties:
type: object
additionalProperties:
type: object
properties:
FieldRight:
type: object
properties:
Mask:
enum:
- None
- Read
- Write
- Update
- Unused1
- Unused2
- Unused3
- Unused4
- Nullable
- UIHintMandatory
- UIHintReadOnly
- FULL
- UIHints
type: string
Reason:
type: string
FieldType:
type: string
FieldLength:
format: int32
type: integer
Accept-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
SO-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
SO-Culture:
type: string
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
SO-TimeZone:
type: string
description: >-
Specify the timezone code that you would like date/time responses
converted to.
SO-AppToken:
type: string
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
required:
- cRMScriptUniqueId
- eventData
title: Parameters