Workflows
Event-driven automation graphs: a trigger (message, keyword, comment, referral, reaction, contact change, API call, schedule) and nodes (send message, reply / private reply, wait, condition, HTTP request, AI reply with Claude, tags, fields, sequences, assignment). Every graph change records a version; runs are durable and have a timeline.
- GET/workflows
- POST/workflows
- GET/workflows/node-types
- GET/workflows/{id}
- PATCH/workflows/{id}
- DEL/workflows/{id}
- POST/workflows/{id}/activate
- POST/workflows/{id}/pause
- POST/workflows/{id}/duplicate
- GET/workflows/{id}/versions
- GET/workflows/{id}/versions/{version}
- POST/workflows/{id}/versions/{version}/restore
- GET/workflows/{id}/executions
- POST/workflows/{id}/executions
- POST/workflows/{id}/trigger
- GET/workflows/{id}/executions/{executionId}
- POST/workflows/{id}/executions/{executionId}/cancel
- GET/workflows/{id}/executions/{executionId}/events
List workflows
/workflowsTry it with MCPAsk your agent to call list-workflows (toolset workflows)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atupdated_atname
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
profile_idstringaccount_idstringstatusstringplatformstringtrigger_typestringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 19 item attributes
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": null,
"y": null
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}Create a workflow
/workflowsValidates the graph structure (unique ids, known node types, edges between real nodes, valid handles). Created as draft.
Try it with MCPAsk your agent to call create-workflow (toolset workflows)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
profile_idstringaccount_idstring | nullplatformstringinstagramfacebookxblueskyredditdiscordmastodontiktoktwitter
namestringrequired1–200 characters
descriptionstring | null≤ 2000 characters
nodesarray of object≤ 200 items
Show 5 item attributes
idstringrequired1–64 characters
typestringrequiredtriggersend_messagereply_to_commentprivate_replywait_for_replyconditionset_variabledelayhttp_requestaiassign_conversationhandoffadd_tagremove_tagset_fieldenroll_sequencea_b_splitstart_callendwaitwebhookai_reply
labelstring | null≤ 80 characters
positionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of object≤ 400 items
Show 5 item attributes
idstringrequired1–64 characters
sourcestringrequired1–64 characters
targetstringrequired1–64 characters
source_handlestring | null≤ 64 characters
sourceHandlestring | null≤ 64 characters
entry_node_idstring | null≤ 64 characters
Returns object
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}List workflow node types
/workflows/node-typesCatalog of node types with their output handles and config JSON schema (drives the builder).
Try it with MCPAsk your agent to call list-workflow-node-types (toolset workflows)Set up MCP
Query parameters
pageintegerdefault: 1≥ 1
limitintegerdefault: 1001–100
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 9 item attributes
objectstringworkflow_node_type
typestringgroupstringlabelstringdescriptionstringhandlesarray of string | nullconfig_schemaobjectplatformsarray of string | nullalias_ofstring | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "workflow_node_type",
"type": "string",
"group": "string",
"label": "string",
"description": "string",
"handles": [
"string"
],
"config_schema": {},
"platforms": [
"string"
],
"alias_of": "string"
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}Get a workflow
/workflows/{id}Try it with MCPAsk your agent to call get-workflow (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Returns object
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Update a workflow
/workflows/{id}The graph (nodes, edges, entry_node_id, replaced wholesale) is editable only while draft or paused (409 workflow_not_editable); name, description and account any time. Graph, name and description changes record a version.
Try it with MCPAsk your agent to call update-workflow (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Body object
namestring1–200 characters
descriptionstring | null≤ 2000 characters
account_idstring | nullnodesarray of object≤ 200 items
Show 5 item attributes
idstringrequired1–64 characters
typestringrequiredtriggersend_messagereply_to_commentprivate_replywait_for_replyconditionset_variabledelayhttp_requestaiassign_conversationhandoffadd_tagremove_tagset_fieldenroll_sequencea_b_splitstart_callendwaitwebhookai_reply
labelstring | null≤ 80 characters
positionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of object≤ 400 items
Show 5 item attributes
idstringrequired1–64 characters
sourcestringrequired1–64 characters
targetstringrequired1–64 characters
source_handlestring | null≤ 64 characters
sourceHandlestring | null≤ 64 characters
entry_node_idstring | null≤ 64 characters
Returns object
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Delete a workflow
/workflows/{id}Try it with MCPAsk your agent to call delete-workflow (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Returns object
objectstringrequiredworkflow
idstringrequireddeletedbooleanrequiredResponses
{
"object": "workflow",
"id": "string",
"deleted": true
}Activate a workflow
/workflows/{id}/activateRequires a complete graph: one trigger, every node reachable and valid, an account when the graph messages (422 workflow_invalid with errors).
Try it with MCPAsk your agent to call activate-workflow (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Returns object
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Pause a workflow
/workflows/{id}/pauseStops new runs; in-flight runs finish.
Try it with MCPAsk your agent to call pause-workflow (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Returns object
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Duplicate a workflow
/workflows/{id}/duplicateTry it with MCPAsk your agent to call duplicate-workflow (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Returns object
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}List workflow versions
/workflows/{id}/versionsTry it with MCPAsk your agent to call list-workflow-versions (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringorderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 14 item attributes
objectstringworkflow_version
idstringworkflow_idstringversionintegernamestringdescriptionstring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullaccount_idstring | nullplatformstring | nullcreated_byobject | nullShow 3 child attributes
typestringidstring | nullnamestring | nullrestored_from_versioninteger | nullcreated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "workflow_version",
"id": "string",
"workflow_id": "string",
"version": 1,
"name": "string",
"description": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": null,
"y": null
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"account_id": "string",
"platform": "string",
"created_by": {
"type": "string",
"id": "string",
"name": "string"
},
"restored_from_version": 1,
"created_at": "2026-10-13T09:00:00.000Z"
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}Get a workflow version
/workflows/{id}/versions/{version}Try it with MCPAsk your agent to call get-workflow-version (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
versionintegerrequired≥ 1
Returns object
objectstringworkflow_version
idstringworkflow_idstringversionintegernamestringdescriptionstring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullaccount_idstring | nullplatformstring | nullcreated_byobject | nullShow 3 child attributes
typestringidstring | nullnamestring | nullrestored_from_versioninteger | nullcreated_atstring (date-time) | nullResponses
{
"object": "workflow_version",
"id": "string",
"workflow_id": "string",
"version": 1,
"name": "string",
"description": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"account_id": "string",
"platform": "string",
"created_by": {
"type": "string",
"id": "string",
"name": "string"
},
"restored_from_version": 1,
"created_at": "2026-10-13T09:00:00.000Z"
}Restore a workflow version
/workflows/{id}/versions/{version}/restoreCopies the version graph back as a new version (restored_from_version). Only while draft or paused.
Try it with MCPAsk your agent to call restore-workflow-version (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
versionintegerrequired≥ 1
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Returns object
objectstringworkflow
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstring | nullnamestringdescriptionstring | nullstatusstringdraftactivepaused
trigger_typestring | nullentry_node_idstring | nullnodesarray of objectShow 5 item attributes
idstringtypestringlabelstring | nullpositionobject | nullShow 2 child attributes
xnumberynumberconfigobjectedgesarray of objectShow 4 item attributes
idstringsourcestringtargetstringsource_handlestring | nullnode_countintegerversionintegerstatsobjectShow 5 child attributes
total_startedintegertotal_completedintegertotal_exitedintegertotal_failedintegerrunningintegeractivated_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"trigger_type": "string",
"entry_node_id": "string",
"nodes": [
{
"id": "string",
"type": "string",
"label": "string",
"position": {
"x": 1.5,
"y": 1.5
},
"config": {}
}
],
"edges": [
{
"id": "string",
"source": "string",
"target": "string",
"source_handle": "string"
}
],
"node_count": 1,
"version": 1,
"stats": {
"total_started": 1,
"total_completed": 1,
"total_exited": 1,
"total_failed": 1,
"running": 1
},
"activated_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}List workflow runs
/workflows/{id}/executionsTry it with MCPAsk your agent to call list-workflow-executions (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atupdated_at
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
statusstringcontact_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 19 item attributes
objectstringworkflow_execution
idstringworkflow_idstringworkflow_versionintegerstatusstringrunningwaitingcompletedexitedfailed
triggerobjectShow 2 child attributes
typestring | nulltextstring | nullcontact_idstring | nullconversation_idstring | nullplatform_identifierstring | nullcurrent_node_idstring | nullwaiting_forobject | nullShow 3 child attributes
kindstringnode_idstring | nulluntilstring | nullvariablesobjectstep_countintegerlast_errorstring | nullresume_atstring (date-time) | nullstarted_atstring (date-time) | nullcompleted_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "workflow_execution",
"id": "string",
"workflow_id": "string",
"workflow_version": 1,
"status": "running",
"trigger": {
"type": "string",
"text": "string"
},
"contact_id": "string",
"conversation_id": "string",
"platform_identifier": "string",
"current_node_id": "string",
"waiting_for": {
"kind": "string",
"node_id": "string",
"until": "string"
},
"variables": {},
"step_count": 1,
"last_error": "string",
"resume_at": "2026-10-13T09:00:00.000Z",
"started_at": "2026-10-13T09:00:00.000Z",
"completed_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}Start a workflow run manually
/workflows/{id}/executionsTest run for any status, on a contact_id, conversation_id or to (phone), with text seeding last_message.
Try it with MCPAsk your agent to call start-workflow-execution (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
contact_idstringconversation_idstringtostring≤ 32 characters
textstring≤ 4096 characters
variablesobjectReturns object
objectstringworkflow_execution
idstringworkflow_idstringworkflow_versionintegerstatusstringrunningwaitingcompletedexitedfailed
triggerobjectShow 2 child attributes
typestring | nulltextstring | nullcontact_idstring | nullconversation_idstring | nullplatform_identifierstring | nullcurrent_node_idstring | nullwaiting_forobject | nullShow 3 child attributes
kindstringnode_idstring | nulluntilstring | nullvariablesobjectstep_countintegerlast_errorstring | nullresume_atstring (date-time) | nullstarted_atstring (date-time) | nullcompleted_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow_execution",
"id": "string",
"workflow_id": "string",
"workflow_version": 1,
"status": "running",
"trigger": {
"type": "string",
"text": "string"
},
"contact_id": "string",
"conversation_id": "string",
"platform_identifier": "string",
"current_node_id": "string",
"waiting_for": {
"kind": "string",
"node_id": "string",
"until": "string"
},
"variables": {},
"step_count": 1,
"last_error": "string",
"resume_at": "2026-10-13T09:00:00.000Z",
"started_at": "2026-10-13T09:00:00.000Z",
"completed_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Trigger an API workflow
/workflows/{id}/triggerFor active workflows with an api_call trigger: one of contact_id, conversation_id or to, plus variables.
Try it with MCPAsk your agent to call trigger-workflow (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
contact_idstringconversation_idstringtostring≤ 32 characters
variablesobjectReturns object
objectstringworkflow_execution
idstringworkflow_idstringworkflow_versionintegerstatusstringrunningwaitingcompletedexitedfailed
triggerobjectShow 2 child attributes
typestring | nulltextstring | nullcontact_idstring | nullconversation_idstring | nullplatform_identifierstring | nullcurrent_node_idstring | nullwaiting_forobject | nullShow 3 child attributes
kindstringnode_idstring | nulluntilstring | nullvariablesobjectstep_countintegerlast_errorstring | nullresume_atstring (date-time) | nullstarted_atstring (date-time) | nullcompleted_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow_execution",
"id": "string",
"workflow_id": "string",
"workflow_version": 1,
"status": "running",
"trigger": {
"type": "string",
"text": "string"
},
"contact_id": "string",
"conversation_id": "string",
"platform_identifier": "string",
"current_node_id": "string",
"waiting_for": {
"kind": "string",
"node_id": "string",
"until": "string"
},
"variables": {},
"step_count": 1,
"last_error": "string",
"resume_at": "2026-10-13T09:00:00.000Z",
"started_at": "2026-10-13T09:00:00.000Z",
"completed_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Get a workflow run
/workflows/{id}/executions/{executionId}Try it with MCPAsk your agent to call get-workflow-execution (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
executionIdstringrequiredworkflowExecution id (wfx_…)
1–80 characters
Returns object
objectstringworkflow_execution
idstringworkflow_idstringworkflow_versionintegerstatusstringrunningwaitingcompletedexitedfailed
triggerobjectShow 2 child attributes
typestring | nulltextstring | nullcontact_idstring | nullconversation_idstring | nullplatform_identifierstring | nullcurrent_node_idstring | nullwaiting_forobject | nullShow 3 child attributes
kindstringnode_idstring | nulluntilstring | nullvariablesobjectstep_countintegerlast_errorstring | nullresume_atstring (date-time) | nullstarted_atstring (date-time) | nullcompleted_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow_execution",
"id": "string",
"workflow_id": "string",
"workflow_version": 1,
"status": "running",
"trigger": {
"type": "string",
"text": "string"
},
"contact_id": "string",
"conversation_id": "string",
"platform_identifier": "string",
"current_node_id": "string",
"waiting_for": {
"kind": "string",
"node_id": "string",
"until": "string"
},
"variables": {},
"step_count": 1,
"last_error": "string",
"resume_at": "2026-10-13T09:00:00.000Z",
"started_at": "2026-10-13T09:00:00.000Z",
"completed_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Stop a workflow run
/workflows/{id}/executions/{executionId}/cancelTry it with MCPAsk your agent to call cancel-workflow-execution (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
executionIdstringrequiredworkflowExecution id (wfx_…)
1–80 characters
Returns object
objectstringworkflow_execution
idstringworkflow_idstringworkflow_versionintegerstatusstringrunningwaitingcompletedexitedfailed
triggerobjectShow 2 child attributes
typestring | nulltextstring | nullcontact_idstring | nullconversation_idstring | nullplatform_identifierstring | nullcurrent_node_idstring | nullwaiting_forobject | nullShow 3 child attributes
kindstringnode_idstring | nulluntilstring | nullvariablesobjectstep_countintegerlast_errorstring | nullresume_atstring (date-time) | nullstarted_atstring (date-time) | nullcompleted_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "workflow_execution",
"id": "string",
"workflow_id": "string",
"workflow_version": 1,
"status": "running",
"trigger": {
"type": "string",
"text": "string"
},
"contact_id": "string",
"conversation_id": "string",
"platform_identifier": "string",
"current_node_id": "string",
"waiting_for": {
"kind": "string",
"node_id": "string",
"until": "string"
},
"variables": {},
"step_count": 1,
"last_error": "string",
"resume_at": "2026-10-13T09:00:00.000Z",
"started_at": "2026-10-13T09:00:00.000Z",
"completed_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Get a run timeline
/workflows/{id}/executions/{executionId}/eventsTry it with MCPAsk your agent to call list-workflow-execution-events (toolset workflows)Set up MCP
Path parameters
idstringrequiredworkflow id (wf_…)
1–80 characters
executionIdstringrequiredworkflowExecution id (wfx_…)
1–80 characters
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringorderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 12 item attributes
objectstringworkflow_execution_event
idstringexecution_idstringactionstringstatusstringnode_idstring | nullnode_typestring | nullsource_handlestring | nullduration_msinteger | nullerror_messagestring | nullmetaobject | nullatstring (date-time)pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "workflow_execution_event",
"id": "string",
"execution_id": "string",
"action": "string",
"status": "string",
"node_id": "string",
"node_type": "string",
"source_handle": "string",
"duration_ms": 1,
"error_message": "string",
"meta": {},
"at": "2026-10-13T09:00:00.000Z"
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}