{
"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
}
{
"data": null,
"error": {
"errorCode": "BAD_REQUEST",
"message": "Bad request"
},
"errors": [
{
"errorCode": "BAD_REQUEST",
"message": "Bad request"
}
],
"meta": null
}
{
"data": null,
"error": {
"errorCode": "UNAUTHORISED",
"message": "Unauthorised"
},
"errors": [
{
"errorCode": "UNAUTHORISED",
"message": "Unauthorised"
}
],
"meta": null
}
{
"data": null,
"error": {
"errorCode": "NOT FOUND",
"message": "Not found"
},
"errors": [
{
"errorCode": "NOT FOUND",
"message": "Not found"
}
],
"meta": null
}
Workflow APIs
Single Trigger
Single Trigger for Workflow
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
}
{
"data": null,
"error": {
"errorCode": "BAD_REQUEST",
"message": "Bad request"
},
"errors": [
{
"errorCode": "BAD_REQUEST",
"message": "Bad request"
}
],
"meta": null
}
{
"data": null,
"error": {
"errorCode": "UNAUTHORISED",
"message": "Unauthorised"
},
"errors": [
{
"errorCode": "UNAUTHORISED",
"message": "Unauthorised"
}
],
"meta": null
}
{
"data": null,
"error": {
"errorCode": "NOT FOUND",
"message": "Not found"
},
"errors": [
{
"errorCode": "NOT FOUND",
"message": "Not found"
}
],
"meta": null
}
Header
string
required
Bearer token for API authentication. Format:
Bearer {{apiToken}}Request Body
{
"workflowName": "<workflow_name>",
"data": {
"<key>": "<value>"
},
"notify": {
"<key>": "<value>"
}
}
Body Parameters
object
data that is being used in the workflow
object
required
The recipient details
{
"workflowName": "otp",
"data": {
"subject": "otp verification"
},
"notify":
{
"notificationType": "email",
"recipient": "example@example.com"
},
}
Response
{
"data": {
"requestId": UUID, // UUID, id of the request
"workflowExecutionId": UUID // UUID, id of the workflow execution
},
"error": null,
"errors": null,
"meta": null
}
{
"data": null,
"error": {
"errorCode": "BAD_REQUEST",
"message": "Bad request"
},
"errors": [
{
"errorCode": "BAD_REQUEST",
"message": "Bad request"
}
],
"meta": null
}
{
"data": null,
"error": {
"errorCode": "UNAUTHORISED",
"message": "Unauthorised"
},
"errors": [
{
"errorCode": "UNAUTHORISED",
"message": "Unauthorised"
}
],
"meta": null
}
{
"data": null,
"error": {
"errorCode": "NOT FOUND",
"message": "Not found"
},
"errors": [
{
"errorCode": "NOT FOUND",
"message": "Not found"
}
],
"meta": null
}
Status Codes
200- OK400- BAD REQUEST401- UNAUTHORISED404- NOT FOUND
Was this page helpful?