Skip to content
Docs

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.

Base URLhttps://api.socialit.com/v1AuthenticationErrorsRate limits18 endpointsMCP toolset workflows

List workflows

GET/workflows

Access: readZernio: GET /v1/workflows

Try it with MCPAsk your agent to call list-workflows (toolset workflows)Set up MCP

Query parameters

pageintegerdefault: 1

Page number

≥ 1

limitintegerdefault: 20

Items per page (max 100)

1–100

sortstring

created_atupdated_atname

orderstring

ascdesc

matchstring

Combine filters with AND (default) or OR

allor

profile_idstring
account_idstring
statusstring
platformstring
trigger_typestring

Returns object

objectstringrequired

list

dataarray of objectrequired
Show 19 item attributes
objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null
pageintegerrequired
limitintegerrequired
totalinteger | null
has_morebooleanrequired
next_page_urlstring | null
previous_page_urlstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows
curl "https://api.socialit.com/v1/workflows" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

POST/workflows

Validates the graph structure (unique ids, known node types, edges between real nodes, valid handles). Created as draft.

Access: writeIdempotency-KeyZernio: POST /v1/workflows

Try it with MCPAsk your agent to call create-workflow (toolset workflows)Set up MCP

Headers

Idempotency-Keystring

Unique 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_idstring
account_idstring | null
platformstring

instagramfacebookxblueskyredditdiscordmastodontiktoktwitter

namestringrequired

1–200 characters

descriptionstring | null

≤ 2000 characters

nodesarray of object

≤ 200 items

Show 5 item attributes
idstringrequired

1–64 characters

typestringrequired

triggersend_messagereply_to_commentprivate_replywait_for_replyconditionset_variabledelayhttp_requestaiassign_conversationhandoffadd_tagremove_tagset_fieldenroll_sequencea_b_splitstart_callendwaitwebhookai_reply

labelstring | null

≤ 80 characters

positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object

≤ 400 items

Show 5 item attributes
idstringrequired

1–64 characters

sourcestringrequired

1–64 characters

targetstringrequired

1–64 characters

source_handlestring | null

≤ 64 characters

sourceHandlestring | null

≤ 64 characters

entry_node_idstring | null

≤ 64 characters

Returns object

objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 201Created
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows
curl -X POST "https://api.socialit.com/v1/workflows" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_id": "string",
    "account_id": "string",
    "platform": "instagram",
    "name": "string",
    "description": "string"
  }'
Response · 201
{
  "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

GET/workflows/node-types

Catalog of node types with their output handles and config JSON schema (drives the builder).

Access: read

Try it with MCPAsk your agent to call list-workflow-node-types (toolset workflows)Set up MCP

Query parameters

pageintegerdefault: 1

≥ 1

limitintegerdefault: 100

1–100

Returns object

objectstringrequired

list

dataarray of objectrequired
Show 9 item attributes
objectstring

workflow_node_type

typestring
groupstring
labelstring
descriptionstring
handlesarray of string | null
config_schemaobject
platformsarray of string | null
alias_ofstring | null
pageintegerrequired
limitintegerrequired
totalinteger | null
has_morebooleanrequired
next_page_urlstring | null
previous_page_urlstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows/node-types
curl "https://api.socialit.com/v1/workflows/node-types" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

GET/workflows/{id}

Access: readZernio: GET /v1/workflows/{workflowId}

Try it with MCPAsk your agent to call get-workflow (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Returns object

objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows/{id}
curl "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

PATCH/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.

Access: writeZernio: PATCH /v1/workflows/{workflowId}

Try it with MCPAsk your agent to call update-workflow (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Body object

namestring

1–200 characters

descriptionstring | null

≤ 2000 characters

account_idstring | null
nodesarray of object

≤ 200 items

Show 5 item attributes
idstringrequired

1–64 characters

typestringrequired

triggersend_messagereply_to_commentprivate_replywait_for_replyconditionset_variabledelayhttp_requestaiassign_conversationhandoffadd_tagremove_tagset_fieldenroll_sequencea_b_splitstart_callendwaitwebhookai_reply

labelstring | null

≤ 80 characters

positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object

≤ 400 items

Show 5 item attributes
idstringrequired

1–64 characters

sourcestringrequired

1–64 characters

targetstringrequired

1–64 characters

source_handlestring | null

≤ 64 characters

sourceHandlestring | null

≤ 64 characters

entry_node_idstring | null

≤ 64 characters

Returns object

objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
PATCH/workflows/{id}
curl -X PATCH "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "account_id": "string",
    "nodes": [
      {
        "id": "string",
        "type": "trigger"
      }
    ],
    "edges": [
      {
        "id": "string",
        "source": "string",
        "target": "string"
      }
    ]
  }'
Response · 200
{
  "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

DELETE/workflows/{id}

Access: writeZernio: DELETE /v1/workflows/{workflowId}

Try it with MCPAsk your agent to call delete-workflow (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Returns object

objectstringrequired

workflow

idstringrequired
deletedbooleanrequired

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
DELETE/workflows/{id}
curl -X DELETE "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "object": "workflow",
  "id": "string",
  "deleted": true
}

Activate a workflow

POST/workflows/{id}/activate

Requires a complete graph: one trigger, every node reachable and valid, an account when the graph messages (422 workflow_invalid with errors).

Access: writeIdempotency-KeyZernio: POST /v1/workflows/{workflowId}/activate

Try it with MCPAsk your agent to call activate-workflow (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Headers

Idempotency-Keystring

Unique 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

objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows/{id}/activate
curl -X POST "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/activate" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Response · 200
{
  "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

POST/workflows/{id}/pause

Stops new runs; in-flight runs finish.

Access: writeIdempotency-KeyZernio: POST /v1/workflows/{workflowId}/pause

Try it with MCPAsk your agent to call pause-workflow (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Headers

Idempotency-Keystring

Unique 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

objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows/{id}/pause
curl -X POST "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/pause" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Response · 200
{
  "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

POST/workflows/{id}/duplicate

Access: writeIdempotency-KeyZernio: POST /v1/workflows/{workflowId}/duplicate

Try it with MCPAsk your agent to call duplicate-workflow (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Headers

Idempotency-Keystring

Unique 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

objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 201Created
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows/{id}/duplicate
curl -X POST "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/duplicate" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Response · 201
{
  "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

GET/workflows/{id}/versions

Access: readZernio: GET /v1/workflows/{workflowId}/versions

Try it with MCPAsk your agent to call list-workflow-versions (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Query parameters

pageintegerdefault: 1

Page number

≥ 1

limitintegerdefault: 20

Items per page (max 100)

1–100

sortstring
orderstring

ascdesc

matchstring

Combine filters with AND (default) or OR

allor

Returns object

objectstringrequired

list

dataarray of objectrequired
Show 14 item attributes
objectstring

workflow_version

idstring
workflow_idstring
versioninteger
namestring
descriptionstring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
account_idstring | null
platformstring | null
created_byobject | null
Show 3 child attributes
typestring
idstring | null
namestring | null
restored_from_versioninteger | null
created_atstring (date-time) | null
pageintegerrequired
limitintegerrequired
totalinteger | null
has_morebooleanrequired
next_page_urlstring | null
previous_page_urlstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows/{id}/versions
curl "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/versions" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

GET/workflows/{id}/versions/{version}

Access: readZernio: GET /v1/workflows/{workflowId}/versions/{version}

Try it with MCPAsk your agent to call get-workflow-version (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

versionintegerrequired

≥ 1

Returns object

objectstring

workflow_version

idstring
workflow_idstring
versioninteger
namestring
descriptionstring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
account_idstring | null
platformstring | null
created_byobject | null
Show 3 child attributes
typestring
idstring | null
namestring | null
restored_from_versioninteger | null
created_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows/{id}/versions/{version}
curl "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/versions/VERSION" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

POST/workflows/{id}/versions/{version}/restore

Copies the version graph back as a new version (restored_from_version). Only while draft or paused.

Access: writeIdempotency-KeyZernio: POST /v1/workflows/{workflowId}/versions/{version}/restore

Try it with MCPAsk your agent to call restore-workflow-version (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

versionintegerrequired

≥ 1

Headers

Idempotency-Keystring

Unique 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

objectstring

workflow

idstring
profile_idstring | null
account_idstring | null
account_namestring | null
platformstring | null
namestring
descriptionstring | null
statusstring

draftactivepaused

trigger_typestring | null
entry_node_idstring | null
nodesarray of object
Show 5 item attributes
idstring
typestring
labelstring | null
positionobject | null
Show 2 child attributes
xnumber
ynumber
configobject
edgesarray of object
Show 4 item attributes
idstring
sourcestring
targetstring
source_handlestring | null
node_countinteger
versioninteger
statsobject
Show 5 child attributes
total_startedinteger
total_completedinteger
total_exitedinteger
total_failedinteger
runninginteger
activated_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows/{id}/versions/{version}/restore
curl -X POST "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/versions/VERSION/restore" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Response · 200
{
  "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

GET/workflows/{id}/executions

Access: readZernio: GET /v1/workflows/{workflowId}/executions

Try it with MCPAsk your agent to call list-workflow-executions (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Query parameters

pageintegerdefault: 1

Page number

≥ 1

limitintegerdefault: 20

Items per page (max 100)

1–100

sortstring

created_atupdated_at

orderstring

ascdesc

matchstring

Combine filters with AND (default) or OR

allor

statusstring
contact_idstring

Returns object

objectstringrequired

list

dataarray of objectrequired
Show 19 item attributes
objectstring

workflow_execution

idstring
workflow_idstring
workflow_versioninteger
statusstring

runningwaitingcompletedexitedfailed

triggerobject
Show 2 child attributes
typestring | null
textstring | null
contact_idstring | null
conversation_idstring | null
platform_identifierstring | null
current_node_idstring | null
waiting_forobject | null
Show 3 child attributes
kindstring
node_idstring | null
untilstring | null
variablesobject
step_countinteger
last_errorstring | null
resume_atstring (date-time) | null
started_atstring (date-time) | null
completed_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null
pageintegerrequired
limitintegerrequired
totalinteger | null
has_morebooleanrequired
next_page_urlstring | null
previous_page_urlstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows/{id}/executions
curl "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/executions" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

POST/workflows/{id}/executions

Test run for any status, on a contact_id, conversation_id or to (phone), with text seeding last_message.

Access: writeIdempotency-KeyZernio: POST /v1/workflows/{workflowId}/executions

Try it with MCPAsk your agent to call start-workflow-execution (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Headers

Idempotency-Keystring

Unique 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_idstring
conversation_idstring
tostring

≤ 32 characters

textstring

≤ 4096 characters

variablesobject

Returns object

objectstring

workflow_execution

idstring
workflow_idstring
workflow_versioninteger
statusstring

runningwaitingcompletedexitedfailed

triggerobject
Show 2 child attributes
typestring | null
textstring | null
contact_idstring | null
conversation_idstring | null
platform_identifierstring | null
current_node_idstring | null
waiting_forobject | null
Show 3 child attributes
kindstring
node_idstring | null
untilstring | null
variablesobject
step_countinteger
last_errorstring | null
resume_atstring (date-time) | null
started_atstring (date-time) | null
completed_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 201Created
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows/{id}/executions
curl -X POST "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/executions" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "string",
    "conversation_id": "string",
    "to": "+15551234567",
    "text": "string",
    "variables": {}
  }'
Response · 201
{
  "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

POST/workflows/{id}/trigger

For active workflows with an api_call trigger: one of contact_id, conversation_id or to, plus variables.

Access: writeIdempotency-KeyZernio: POST /v1/workflows/{workflowId}/trigger

Try it with MCPAsk your agent to call trigger-workflow (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

Headers

Idempotency-Keystring

Unique 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_idstring
conversation_idstring
tostring

≤ 32 characters

variablesobject

Returns object

objectstring

workflow_execution

idstring
workflow_idstring
workflow_versioninteger
statusstring

runningwaitingcompletedexitedfailed

triggerobject
Show 2 child attributes
typestring | null
textstring | null
contact_idstring | null
conversation_idstring | null
platform_identifierstring | null
current_node_idstring | null
waiting_forobject | null
Show 3 child attributes
kindstring
node_idstring | null
untilstring | null
variablesobject
step_countinteger
last_errorstring | null
resume_atstring (date-time) | null
started_atstring (date-time) | null
completed_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 201Created
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows/{id}/trigger
curl -X POST "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/trigger" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "string",
    "conversation_id": "string",
    "to": "+15551234567",
    "variables": {}
  }'
Response · 201
{
  "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

GET/workflows/{id}/executions/{executionId}

Access: read

Try it with MCPAsk your agent to call get-workflow-execution (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

executionIdstringrequired

workflowExecution id (wfx_…)

1–80 characters

Returns object

objectstring

workflow_execution

idstring
workflow_idstring
workflow_versioninteger
statusstring

runningwaitingcompletedexitedfailed

triggerobject
Show 2 child attributes
typestring | null
textstring | null
contact_idstring | null
conversation_idstring | null
platform_identifierstring | null
current_node_idstring | null
waiting_forobject | null
Show 3 child attributes
kindstring
node_idstring | null
untilstring | null
variablesobject
step_countinteger
last_errorstring | null
resume_atstring (date-time) | null
started_atstring (date-time) | null
completed_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows/{id}/executions/{executionId}
curl "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/executions/wfx_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

POST/workflows/{id}/executions/{executionId}/cancel

Access: write

Try it with MCPAsk your agent to call cancel-workflow-execution (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

executionIdstringrequired

workflowExecution id (wfx_…)

1–80 characters

Returns object

objectstring

workflow_execution

idstring
workflow_idstring
workflow_versioninteger
statusstring

runningwaitingcompletedexitedfailed

triggerobject
Show 2 child attributes
typestring | null
textstring | null
contact_idstring | null
conversation_idstring | null
platform_identifierstring | null
current_node_idstring | null
waiting_forobject | null
Show 3 child attributes
kindstring
node_idstring | null
untilstring | null
variablesobject
step_countinteger
last_errorstring | null
resume_atstring (date-time) | null
started_atstring (date-time) | null
completed_atstring (date-time) | null
created_atstring (date-time) | null
updated_atstring (date-time) | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
POST/workflows/{id}/executions/{executionId}/cancel
curl -X POST "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/executions/wfx_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/cancel" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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

GET/workflows/{id}/executions/{executionId}/events

Access: readZernio: GET /v1/workflows/{workflowId}/executions/{executionId}/events

Try it with MCPAsk your agent to call list-workflow-execution-events (toolset workflows)Set up MCP

Path parameters

idstringrequired

workflow id (wf_…)

1–80 characters

executionIdstringrequired

workflowExecution id (wfx_…)

1–80 characters

Query parameters

pageintegerdefault: 1

Page number

≥ 1

limitintegerdefault: 20

Items per page (max 100)

1–100

sortstring
orderstring

ascdesc

matchstring

Combine filters with AND (default) or OR

allor

Returns object

objectstringrequired

list

dataarray of objectrequired
Show 12 item attributes
objectstring

workflow_execution_event

idstring
execution_idstring
actionstring
statusstring
node_idstring | null
node_typestring | null
source_handlestring | null
duration_msinteger | null
error_messagestring | null
metaobject | null
atstring (date-time)
pageintegerrequired
limitintegerrequired
totalinteger | null
has_morebooleanrequired
next_page_urlstring | null
previous_page_urlstring | null

Responses

  • 200OK
  • 4XXErrors: invalid request, auth, permission, not found, conflict, plan or rate limit
  • 5XXErrors: server or upstream network error
GET/workflows/{id}/executions/{executionId}/events
curl "https://api.socialit.com/v1/workflows/wf_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/executions/wfx_2Jx0Fq5Pz8vYkB3mN6rT1wQ9sLd/events" \
  -H "Authorization: Bearer $SOCIALIT_API_KEY"
Response · 200
{
  "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"
}