Appearance
github.workflow-dispatch
Handle GitHub workflow_dispatch webhook events — launch ephemeral runners
DAG-based GitHub workflow_dispatch handler.
Routes workflow_dispatch webhook events to ephemeral runner executions. Supports ECS/Fargate (AWS), Cloud Run (GCP), Container Apps (Azure), App Platform (DO).
Layers 3-4 (launch_runner, complete) are conditional on the warm-pool no-op: when select_runner_group returns dispatch_skipped=True they are skipped and the run completes without an ephemeral launch.
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 | — | — |
select_runner_group | dict | No | — | — |
launch_runner | 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_and_route | github.workflow-dispatch-validate | — |
| 2 | select_runner_group | github.workflow-dispatch-select-runner | — |
| 3 | launch_runner | github.workflow-dispatch-launch | — |
| 4 | complete | github.workflow-dispatch-complete | — |
Execution Flow
Sub-workflows
| Sub-workflow | Step name |
|---|---|
github.workflow-dispatch-validate | validate |
github.workflow-dispatch-select-runner | select_runner_group |
github.workflow-dispatch-launch | launch_runner |
github.workflow-dispatch-complete | complete |
Business Errors
| Code | Message Template |
|---|---|
DELIVERY_ID_REQUIRED | delivery_ref is required |
EVENT_TYPE_REQUIRED | event_type is required |
PAYLOAD_REQUIRED | payload is required |
REPOSITORY_NOT_FOUND | Repository not found in workflow_dispatch payload |
RUNNER_GROUP_NOT_FOUND | No suitable runner group found for this workflow dispatch |
UNSUPPORTED_BACKEND | Runner group uses an unsupported backend for ephemeral execution |
API Usage
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.workflow-dispatch",
"initial_data": {
"delivery_ref": "value",
"event_type": "value",
"payload": "value"
}
}