HomeAPI ReferenceGuides
API Reference

Broadcast event to all

post
https://example.com/api/v1/events/trigger/broadcast

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

payload
object
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.

string

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

Unique identifier of a subscriber in your systems

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago