Skip to main content
POST
https://api-ai.zixflow.com
/
api
/
ingest
/
transflow
/
v1
/
{transflow_id}
/
trigger
Trigger Transflow
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingest/transflow/v1/{transflow_id}/trigger \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "recipients": {
    "phone": "<string>",
    "email": "<string>"
  },
  "variables": {}
}
'
{
  "success": true,
  "message": "Transflow triggered successfully",
  "request_id": "req_1234567890"
}

​
Description

This endpoint allows you to trigger a Transflow automation workflow. You can pass recipient information (phone and email) and custom variables to the workflow, and optionally run it in draft mode for testing.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Path Parameters

​
transflow_id
string
required
The unique identifier of the Transflow workflow to trigger.

​
Query Parameters

​
is_draft
boolean
Whether to run the workflow in draft mode. Default: false. Use true for testing workflows.

​
Body

​
recipients
object
required
Recipient information for the workflow. Contains fixed phone and email fields.
​
variables
object
Key-value pairs for template variables. Keys should match the variable names in your Transflow workflow, and values will replace the placeholders.

​
Request Example

{
  "recipients": {
    "phone": "919876543210",
    "email": "demo@example.com"
  },
  "variables": {
    "name": "sam"
  }
}

​
Response

​
success
boolean
Indicates whether the call was successful. true if successful, false if not.
​
message
string
Success or error response message.
​
request_id
string
The unique identifier for this workflow execution request. Use this ID to stop the workflow if needed.
{
  "success": true,
  "message": "Transflow triggered successfully",
  "request_id": "req_1234567890"
}