Skip to main content
Send 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.

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

WorkflowEvent

SendEvent: Send a workflow event. Most event signaling will finish very quickly as they normally just change the state of a workflow instance

WorkflowEvent
object

Workflow event carrier Carrier object for WorkflowEvent. Services for the WorkflowEvent Carrier is available from the Workflow Agent.

Response

OK

Workflow event result carrier Carrier object for WorkflowEventResult. Services for the WorkflowEventResult Carrier is available from the Workflow Agent.

EventType
enum<string>

The workflow event type

Available options:
None,
Run,
PersonCreated,
PersonUpdated,
AddedToProject,
CreatedRequest,
LinkClicked,
AddedToSelection,
FormSubmitted,
AddedMessage,
StartedChat,
OrderPlaced,
SaleCreated,
SaleSold,
SaleLost
Attributes
string

Event result info

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.