github.workflow-dispatch-complete ​
Record that workflow_dispatch execution was started
Complete a workflow_dispatch DAG — record that execution was started.
Inputs:
- organization_uuid: Organization UUID (public) (required)
- runner_execution_uuid: Runner execution UUID (required)
- runner_group_uuid: Runner group UUID (required)
- github_workflow_run_ref: GitHub workflow run reference (required)
- repository_full_name: Full name "owner/repo" (required)
- actor: Username who triggered the workflow (required)
Outputs (terminal state_data):
- completed_at: ISO timestamp
- workflow_dispatch_processed: True
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | Organization UUID (public) |
runner_execution_uuid | uuid | Yes | — | Runner execution UUID |
runner_group_uuid | uuid | Yes | — | Runner group UUID |
github_workflow_run_ref | integer | No | — | Workflow run ID |
repository_full_name | string | Yes | — | Repository full name |
actor | string | Yes | — | Actor who triggered workflow |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
completed_at | string | No | — | ISO timestamp |
workflow_dispatch_processed | string | No | — | Whether dispatch was processed |
organization_uuid | string | No | — | Organization UUID (public) |
runner_execution_uuid | string | No | — | Runner execution UUID |
runner_group_uuid | string | No | — | Runner group UUID |
github_workflow_run_ref | integer | No | — | Workflow run ID |
repository_full_name | string | No | — | Repository full name |
actor | string | No | — | Actor who triggered workflow |
workflow_run_id | string | No | — | Parent DAG run ID |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.workflow-dispatch-complete",
"initial_data": {
"organization_uuid": "value",
"runner_execution_uuid": "value",
"runner_group_uuid": "value",
"repository_full_name": "value"
}
}