Skip to main content
POST
/
api
/
v2
/
workflows
/
trigger
/
bulk
{
  "workflowName": "otp",
  "data": {
    "subject": "otp verification"
  },
  "notify": [
    {
      "notificationType": "email",
      "recipient": "example@example.com"
    },
    {
      "notificationType": "sms",
      "recipient": "+1234567890"
    }
  ]
}

{
  "data": {
    "requestId": UUID,    //id of the request
    "workflowExecutionIds": [UUID]    // list of workflow execution ids
  },
  "error": null,
  "errors": null,
  "meta": null
}
The same API endpoint is used to trigger scheduled workflows.
​
apiToken
string
required
Bearer token for API authentication. Format: Bearer {{apiToken}}
Request Body
{
  "workflowName": "<workflow_name>",
  "data": {
    "<key>": "<value>"
  },
  "notify": [
    {
      "<key>": "<value>"
    }
  ]
}

​
Body Parameters

​
data
object
Data that is being used in the workflow
​
notify
object
required
In Bulk trigger, this attribute is an array of objects. Bulk trigger is used when multiple recipients are there.
{
  "workflowName": "otp",
  "data": {
    "subject": "otp verification"
  },
  "notify": [
    {
      "notificationType": "email",
      "recipient": "example@example.com"
    },
    {
      "notificationType": "sms",
      "recipient": "+1234567890"
    }
  ]
}

​
Response

​
data
object
​
requestId
UUID
UUID — identifier for the bulk request.
​
workflowExecutionIds
array
Array of UUIDs — each corresponding to an individual workflow execution.
​
errorCode
string
The error code (e.g., BAD_REQUEST).
​
message
string
A human-readable error message.
{
  "data": {
    "requestId": UUID,    //id of the request
    "workflowExecutionIds": [UUID]    // list of workflow execution ids
  },
  "error": null,
  "errors": null,
  "meta": null
}

​
Status Codes

  • 200 - OK
  • 400 - BAD REQUEST
  • 401 - UNAUTHORISED
  • 404 - NOT FOUND