Skip to main content
POST
Start a workflow run

Authorizations

X-API-Key
string
header
required

Workspace API key with workflow run, and workflow read to check status.

Headers

Idempotency-Key
string
required

Stable key reused when retrying the same request

Concurrency-Key
string

Runs sharing this key never overlap. Omit to allow parallel runs.

Cooldown-Minutes
integer

With Concurrency-Key: refuse new runs for that key until this many minutes after its last run ended (0-10080).

Required range: 0 <= x <= 10080

Path Parameters

workflowId
string
required

Published workflow ID

Body

application/json
context
object

Initial values for the run. phone_number becomes {{phone_number}} in later steps.

Example:

Response

Run accepted

success
boolean
required
Example:

true

data
object
required