Cancel Workflow Run
github.cancel_workflow_run
ActionBusiness appsconnection required
Calls POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel.
Cancel an Actions run that is queued or in progress.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- GitHub
- Secret shape
- the GitHub personal access token
- Resolved by
- config.connection_id, else node.connection_id, else the tenant's sole GitHub connection
Configuration
3 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
owner Repository owner — the user or organisation login. Supports {{ }}. | string | Yes | — | — | octocat |
repo Repository name, without the owner prefix. Supports {{ }}. | string | Yes | — | — | hello-world |
run_id Numeric workflow run id, as returned by list_workflow_runs. | string | Yes | — | — | 1 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"owner": "octocat",
"repo": "hello-world",
"run_id": "1"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when GitHub accepted the call. | boolean | true |
run_id The run that was asked to cancel. | string | — |
{
"ok": true,
"run_id": ""
}Notes
- GitHub answers 202: the cancellation is accepted, not finished. Read the run again to see it reach a cancelled conclusion.
Solutions with GitHub
See Cancel Workflow Run run in a workflow.
In a technical demo we add the GitHub connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.