Broadcast event to all
Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc. In the future could be used to trigger events to a subset of subscribers based on defined filters.
Authorization
bearerAuth JWT access token returned by Signing In (POST /auth/v1/tokens/).
In: header
Request Body
application/json
The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.
The payload object is used to pass additional custom information that could be used to render the template, or perform routing rules based on it. This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.
A unique identifier for this transaction, we will generated a UUID if not provided.
It is used to display the Avatar of the provided actor's subscriber id or actor object. If a new actor object is provided, we will create a new subscriber in our system
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/events/trigger/broadcast" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "payload": {} }'{ "data": { "acknowledged": true, "status": "processed", "error": [ "string" ], "transactionId": "string" }}Bulk trigger event POST
Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.
Cancel triggered event DELETE
Using a previously generated transactionId during the event trigger, will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...