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

​
Description

This endpoint allows you to trigger a Transflow automation workflow. You can pass custom data 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

​
workspace_id
string
required
The unique identifier of the workspace where the Transflow is configured.
​
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

​
data
object
Custom data object to pass to the Transflow workflow. The structure depends on your workflow configuration.
​
record_id
string
Optional record ID to associate with the workflow execution.
​
contact_id
string
Optional contact ID to associate with the workflow execution.

​
Response

​
status
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.
{
  "status": true,
  "message": "Transflow triggered successfully",
  "request_id": "req_1234567890"
}