POST
/
flows
/
trigger
/
{flowId}
import Worqhat from 'worqhat';

const client = new Worqhat({
  apiKey: 'My API Key',
});

const response = await client.flows.triggerWithPayload('f825ab82-371f-40cb-9bed-b325531ead4a', {
  body: { key1: 'bar', key2: 'bar' },
});

console.log(response.analytics_id);
{
  "success": true,
  "message": "Workflow f825ab82-371f-40cb-9bed-b325531ead4a triggered successfully",
  "analytics_id": "1f9152dc-dec8-496f-8ba4-ed1c27a72684",
  "timestamp": "2025-07-26T03:28:08.123Z",
  "data": {
    "workflow_status": "started",
    "additional_data": "from backend response"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Format - "Bearer YOUR_API_KEY"

Path Parameters

​
flowId
string
required

ID of the workflow to trigger

Example:

"f825ab82-371f-40cb-9bed-b325531ead4a"

Body

application/json · object

JSON payload to send to the workflow

The body is of type object.

Response

Workflow triggered successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Workflow f825ab82-371f-40cb-9bed-b325531ead4a triggered successfully"

​
analytics_id
string<uuid>
Example:

"1f9152dc-dec8-496f-8ba4-ed1c27a72684"

​
timestamp
string<date-time>
Example:

"2025-07-26T03:28:08.123Z"

​
data
object
Example:
{
  "workflow_status": "started",
  "additional_data": "from backend response"
}