Sign in

v1

latestOpenAPI 3.1.02026-07-24403468.9 KB
Events

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.

post/v1/events/trigger/broadcast

Request body

namestring required

The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.

payloadobject required

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.

transactionIdstring

A unique identifier for this transaction, we will generated a UUID if not provided.

Example request

{
  "payload": {
    "comment_id": "string",
    "post": {
      "text": "string"
    }
  }
}

Response