Appearance
runner.dispatch-from-job-queued ​
Select an active runner group whose labels cover the job's runner_labels and start runner.execution-launch-* on it; respects max_count.
Pick a matching runner group for a queued GH job and launch one runner.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
repository_full_name | string | Yes | — | — |
runner_labels | list | Yes | — | — |
github_job_ref | integer | No | — | — |
github_workflow_run_ref | integer | No | — | — |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this action, injected server-side from the authenticated request; used for audit/attribution only. Omitted for system/webhook-triggered dispatches with no human actor. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups; echoed on output alongside terminal/error payloads. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. Echoed on output alongside terminal/error payloads. |
runner_execution_uuid | uuid | No | — | UUID of the RunnerExecution this action operates on, picked from the organization's (optionally group-scoped) list of executions; echoed on output alongside terminal/error payloads. |
workflow_uuid | string | No | — | Engine workflow-run identifier (or, for GitHub-Actions-triggered flows, an external GitHub Actions run id) associated with this record; not a platform entity foreign key despite the name. No source is attached since there is no list/query workflow for an internal run id. |
status | string | No | — | — |
outcome | string | No | — | — |
initiated_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this action, injected server-side from the authenticated request when available; used for audit/attribution only. Optional — omitted for system or service-triggered actions with no human actor. |
reason | string | No | — | — |
workflow_run_uuid | string | No | — | Engine-stamped correlation/run id for this DAG execution (ADR-015/E1 plumbing), written into state_data by action_start; not a foreign key to any business entity. No source is attached since there is no list/query workflow for an internal run id. |
retry_count | integer | No | — | — |
retried_from | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | json | No | — | — |
compensation_trigger | json | No | — | — |
comp_current_layer | json | No | — | — |
comp_queue | json | No | — | — |
comp_retry_count | json | No | — | — |
repository_full_name | string | No | — | — |
runner_labels | list | No | — | — |
requested_labels | list | No | — | — |
matched_runner_group_uuid | uuid | No | — | UUID of the RunnerGroup matched to this queued job's labels, echoed on output when a match is found. |
active_execution_count | integer | No | — | — |
reconciled_executions | integer | No | — | — |
max_count | integer | No | — | — |
launched_workflow_uuid | string | No | — | Engine-stamped run id of the runner.execution-launch-* workflow started by this dispatch, when one was launched (legacy direct-launch backends only); not a business entity reference. |
launched_workflow_type | string | No | — | — |
github_job_ref | integer | No | — | — |
github_workflow_run_ref | integer | No | — | — |
queued_demand_hint | json | No | — | — |
reconcile_workflow_uuid | string | No | — | Deterministic workflow_id used to debounce the per-group pool-reconcile trigger for this dispatch, set only on the controller-handoff path; a locally constructed idempotency key, not a stored entity reference. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | match | — |
matching | No | No | — | launch | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | match | matching | — |
matching | launch | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.dispatch-from-job-queued",
"initial_data": {
"organization_uuid": "value",
"repository_full_name": "value",
"runner_labels": "value"
}
}