A run is one execution of a published workflow. These endpoints are for watching runs and repairing the ones that get stuck.
GET /workflow-runs/{run_id} returns the run with its step execution timeline. Variable and step outputs are redacted before they are returned.
Repairing a run
| Action | When to use it |
|---|---|
retry | The run failed. It re-runs from the failed step; steps that already succeeded keep their outputs and are not re-executed. |
refresh-status | The run is waiting on a verification step and the webhook that should have advanced it never arrived. This re-checks the step with the verification provider and advances the run if it has resolved. Verification steps only. |
cancel | You want to stop an in-progress or waiting run. External resources already created, such as verification links, are left as they are. |
In this section
| Endpoint | What it does |
|---|---|
GET /workflow-runs | List runs, newest first, filterable by status and definition |
GET /workflow-runs/{run_id} | Fetch one run with its step timeline |
POST /workflow-runs/{run_id}/retry | Re-run from the failed step |
POST /workflow-runs/{run_id}/refresh-status | Re-check a waiting verification step |
POST /workflow-runs/{run_id}/cancel | Cancel an in-progress or waiting run |