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)

Response

202 - application/json

202 - Accepted

Confirmation that the event was accepted for processing.

message
string

Status message indicating the event was accepted.

Example:

"OK"