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

{
  "data": {
    "requestId": UUID,    // UUID, id of the request
    "workflowExecutionId": UUID    // UUID, id of the workflow execution
  },
  "error": null,
  "errors": null,
  "meta": null
}
​
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
The recipient details
{
  "workflowName": "otp",
  "data": {
    "subject": "otp verification"
  },
  "notify":
    {
      "notificationType": "email",
      "recipient": "example@example.com"
    },
}

​
Response

​
data
object
​
requestId
UUID
UUID, id of the request.
​
workflowExecutionId
UUID
UUID, id of the workflow execution.
​
error
object
​
errorCode
string
The error code (e.g., BAD_REQUEST).
​
message
string
A human-readable error message.
{
  "data": {
    "requestId": UUID,    // UUID, id of the request
    "workflowExecutionId": UUID    // UUID, id of the workflow execution
  },
  "error": null,
  "errors": null,
  "meta": null
}

​
Status Codes

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