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

secretKey

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <secret_key>".

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

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

payload*

The payload object is used to pass additional information that could be used to render the template, or perform routing rules based on it. For In-App channel, payload data are also available in

overrides?

This could be used to override provider specific configurations

transactionId?string

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

actor?|

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

tenant?|

It is used to specify a tenant context during trigger event. If a new tenant object is provided, we will create a new tenant.

context?

Response Body

`application/json`

curl -X POST "https://example.com/v1/events/trigger/broadcast" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "payload": {      "comment_id": "string",      "post": {        "text": "string"      }    }  }'

{  "data": {    "acknowledged": true,    "status": "error",    "error": [      "string"    ],    "transactionId": "string",    "activityFeedLink": "string",    "jobData": {}  }}

Authorization

Request Body

Response Body

200application/json

201application/json

400application/json

401application/json

403application/json

404application/json

405application/json

409application/json

413application/json

414application/json

415application/json

422application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`