Trigger¶

Triggers an event for listeners across all processes and returns an array of IDs for the triggered work items. If no listeners are found, the return value is an empty array.

Required Scope¶

event_trigger

Parameters¶

Parameter Name	Description
`apiKey`	A unique key used to authenticate and authorise the calling system.
`logonId`	User’s logon Id.
`logonProvider`	The authentication provider used for user login (e.g., 'Organization' for Emakin's default login system).
`eventName`	The name of the event to trigger.
`testMode`	Determines whether the event should also trigger for items in test mode.
`inputData`	Event data in XML format. This can be null.
`culture`	The culture preference. This can be null.

Example Call¶

POST https://mydomain.emakin.com/rest/v1/trigger

{
     "apiKey": "xxxx",
     "logonId": "[email protected]",
     "logonProvider": "Organization",
     "eventName" : "myEvent",
     "inputData": "<pool><eventParameter>ABC</eventParameter></pool>",
     "testMode": false,
     "culture": null
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

["716F8FCB-98C2-4591-8C43-043D54DEAADA"]