Skip to main content
POST
Run a workflow

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Path Parameters

workflow_id
integer
required

ID of the workflow.

Example:

123

Body

application/json

Run options

Request body for running the workflow's latest revision on demand.

payload
object

Stands in for the trigger payload and is validated like a real delivery: a webhook body against the trigger's JSON schema, an event payload against the event's payload specs. Defaults to an empty object. Ignored for scheduled workflows.

Response

Created

A single run of a workflow.

id
integer
required

Unique identifier of the execution, also used by its nested execution task routes.

Example:

91

manual
boolean
required

true when the execution was started on demand, for example with POST /workflows/{workflow_id}/executions. false when the workflow's trigger started it.

Example:

false

name
string
required

Name of the execution, unique within its revision. It's composed of the revision ID, the start time and a random suffix.

Example:

"789-20260730_020000-1a2b3c4d"

revision_id
integer
required

ID of the workflow revision that was executed.

Example:

17

started_at
string<date-time>
required

When the execution started.

Example:

"2026-07-30T02:00:00.000000Z"

status
enum<string>
required

Current status of the execution: pending (queued, not started), executing, succeeded or failed.

Available options:
pending,
executing,
succeeded,
failed
Example:

"succeeded"

task_count
integer
required

Number of billable execution tasks the execution ran, recorded when it finishes and 0 until then.

Example:

3

workflow_id
integer
required

ID of the workflow that was executed.

Example:

8

finished_at
string<date-time> | null

When the execution finished, or null while it is still running.

Example:

"2026-07-30T02:04:12.000000Z"

url
string<uri>

Direct link to the entity in the Orchestrator UI.

Example:

"https://eu.phrase.com/orchestrator/manage/workflows/8/executions/91"