Skip to main content
POST
Trigger an Event

Authorizations

Authorization
string
header
required

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

Body

application/json
distinct_id
string
default:_distinct_id_
required

distinct_id of recipient who should receive the notification

event
string
default:_event_name_
required

string identifier for the event like product_purchased

properties
object

Properties are used to render template or workflow variables in the trigger.

tenant_id
string

string identifier of the tenant this event is associated with

$idempotency_key
string

Idempotency key (valid for 24hours)

cancellation_key
string

Lookup key stored on each execution this event triggers, so a Cancel Workflow node can later stop them by matching on it. Pass a literal string (max 512 characters; longer values are truncated). Overrides a target workflow's own Trigger-node Cancellation Key expression when both are present.

Maximum string length: 512
Example:

"booking-123"

Response

202 - text/plain

202 - Accepted

Plain-text confirmation that the event was accepted for processing.

Example:

"OK"