Skip to main content
POST
Run a workflow now

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app whose workflows you want to work with.

workflow_id
string
required

ID of the workflow, as returned in id by List workflows.

Body

application/json
replay_from_run_id
string | null

Run whose trigger payload to reuse for this run. Required when Get workflow run-now options reports requires_previous_run. Leave it out otherwise.

Example:

"0195f2a1-4c3e-7b21-9f0d-2a5c8e1b4d77"

Response

The workflow run is queued, or the hook evaluation has completed.

Confirmation of a queued workflow run or a completed hook evaluation.

status
string
required

Either started for a queued workflow or completed for a synchronously evaluated hook.

Example:

"started"

message
string
required

Confirmation text you can show someone.

Example:

"Run started"

run_id
string | null

ID of the run. Pass it to Get workflow run to read its details.

Example:

"0195f2a1-4c3e-7b21-9f0d-2a5c8e1b4d77"