Skip to main content
POST
Bulk trigger uses this same endpoint (POST /trigger/), just pass array of entire workflow object in the body.

Authorizations

Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Body

application/json

Send a single workflow trigger object as the request body.

workflow
string
default:_workflow_slug_
required

You can get workflow slug from workflow settings on SuprSend dashboard.

recipients
(Identify user inline · object | Notify object · object)[]
required

List of recipients to be notified. You can either add recipient as array of distinct_ids or array of recipient objects. You can add up to 100 recipients in a single API.

You can pass user properties and channels inline in workflow trigger request. Properties and channels passed here also update in user profile on workflow trigger.

actor
object

Includes distinct_id and properties of the user who performed the action. You can use it for cross-user notifications [blocked]. Actor properties can be added as $actor.<prop>.

data
object

variable data required to render dynamic template content or workflow properties like dynamic delay or channel override in send node.

tenant_id
string

Tenant context for this trigger. Applies the tenant's branding, admin preferences, and vendor routing, and — for users with a per-tenant profile — resolves recipients against the merged (global + per-tenant) profile.

$idempotency_key
string

Idempotency_key (valid for 24hrs)

cancellation_key
string

Lookup key stored on the running execution so a Cancel Workflow node can later stop this run by matching on it. Pass a literal string (max 512 characters; longer values are truncated). When both this field and the target workflow's Trigger-node Cancellation Key JSONNET expression are present, this payload value wins.

Maximum string length: 512
Example:

"booking-123"

Response

202 - Accepted (returned for single workflow trigger requests).

All workflow requests will be accepted as long as the API request is correct. To verify if the execution was successful, check the 'Requests' tab under the 'Logs' section on the SuprSend dashboard.

message_id
string

Unique identifier of the message generated by SuprSend.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

status
string
Example:

"success"