Trigger Event
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. Additional information can be passed according the body interface below.
workflowId
string
required
The ID of the Workflow you created.
target
object
required
Information of the message recipient.
subcriberId
string
required
We will create a subscriber with the ID you provide.
phone
string
required
email
string
required
...variables
any[]
optional
The variables you self-define in the workflow.
overrides
object
optional
Override the variables we predefined.
ENDPOINTS
POST
/v1/trigger
REQUEST
{
"workflowId": "string",
"data": {},
"target": {
"subcriberId": "string",
"phone": "string",
"email": "string"
},
"overrides": {}
}RESPONSE
200
{
"transactionId": "string"
}