Sign inGet started
Docs
Get started

Run Workflow

Start a run and get its id back right away. Execution is asynchronous: poll Get Run to follow it. Needs the workflow:run permission.

POST

Path

Path parameters
stringrequired

The id of the workflow to run. It must be enabled.

Headers

Optional headers
string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Body

Arguments
string

"published" (default) or "draft".

Default: published

  • published
  • draft
string

The environment to run in, from List Environments.

Response fields

idstring

The workflow log id. Poll GET /v2/runs/:runId with this id for the outcome.

workflowIdstring

The workflow that was started.

statusstring

Always waiting: the run is queued.

  • waiting
versionstring

The version that runs: published or draft.

  • published
  • draft
environmentIdstring

The environment it runs in, or null for the default.