Notifly
API ReferenceEvents

Bulk trigger event

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.

POST
/v1/events/trigger/bulk
  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.

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.

Response Body

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

curl -X POST "https://example.com/v1/events/trigger/bulk" \  -H "Content-Type: application/json" \  -d '{    "events": [      {        "name": "workflow_identifier",        "to": [          {            "subscriberId": "string"          }        ]      }    ]  }'
{  "data": [    {      "acknowledged": true,      "status": "error",      "error": [        "string"      ],      "transactionId": "string",      "activityFeedLink": "string",      "jobData": {}    }  ]}

Trigger event POST

Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below. To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.

Broadcast event to all POST

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.