Zernio
Zernio
API Reference

Workflows

Workflows

List workflowsGETCreate workflowPOSTGet workflow with graphGETUpdate workflowPATCHDelete workflowDELETEActivate workflowPOSTPause workflowPOSTDuplicate a workflowPOST

Runs

List workflow runsGETManually start a workflow runPOSTGet an execution's timelineGET

Versions

List a workflow's version historyGETGet a specific workflow versionGETRestore a workflow versionPOST

Other

Start an API-triggered workflowPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Workflows

Manually start a workflow run

Kick off a run without waiting for an inbound message (useful for testing). Target an existing conversation by conversationId, or (WhatsApp only) a phone number via to (a conversation is found or created). text seeds the run's lastMessage variable. The graph must be runnable.


POST
/v1/workflows/{workflowId}/executions

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

workflowId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Provide either to (WhatsApp phone) or conversationId.

Response Body

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.workflows.triggerWorkflow({  path: {    workflowId: 'workflow_abc123',  },  body: {    to: 'string',    conversationId: 'conversation_abc123',    text: 'Hello, world!',  },});console.log(data);
{  "success": true,  "execution": {    "id": "string",    "status": "string",    "currentNodeId": "string",    "waitingFor": {},    "variables": {},    "conversationId": "string"  }}
Was this page helpful?

List workflow runs

Returns recent executions (runs) with their status, current node, and accumulated variables.

Get an execution's timeline

Returns the per-step run-log for a single workflow execution: trigger fired, each node visited, edge handles taken, errors, and durations. Backed by Tinybird (90-day retention). Used by the Runs UI drawer to render the timeline.

to?string

Recipient phone (WhatsApp only)

conversationId?string

An existing conversation to run in (required for non-WhatsApp workflows)

text?string

Simulated inbound text, seeded as the run's lastMessage variable