Appearance
github.workflow-run ​
Handle GitHub workflow_run webhook events
DAG-based GitHub workflow_run handler.
Handles workflow_run events — primarily for stopping ephemeral runners when a workflow run completes.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Dag |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | Yes | — | Webhook delivery ID |
event_type | string | Yes | — | Webhook event type |
action | string | No | — | Webhook action |
payload | dict | Yes | — | Webhook payload |
organization_uuid | string | No | — | Organization UUID (public) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | No | — | — |
event_type | string | No | — | — |
action | string | No | — | — |
payload | dict | No | — | — |
organization_uuid | string | No | — | — |
workflow_run_uuid | string | No | — | — |
validate | dict | No | — | — |
handle_completion | dict | No | — | — |
complete | dict | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | integer | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
DAG Layers ​
| # | Layer | Steps | Compensation |
|---|---|---|---|
| 1 | validate | github.workflow-run-validate | — |
| 2 | handle_completion | github.workflow-run-handle-completion | — |
| 3 | complete | github.workflow-run-complete | — |
Execution Flow ​
Sub-workflows ​
| Sub-workflow | Step name |
|---|---|
github.workflow-run-validate | validate |
github.workflow-run-handle-completion | handle_completion |
github.workflow-run-complete | complete |
Business Errors ​
| Code | Message Template |
|---|---|
WORKFLOW_RUN_ERROR | An unknown error occurred |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.workflow-run",
"initial_data": {
"delivery_ref": "value",
"event_type": "value",
"payload": "value"
}
}