Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes—Organization UUID (public)
runner_execution_uuiduuidYes—Runner execution UUID
runner_group_uuiduuidYes—Runner group UUID
github_workflow_run_refintegerNo—Workflow run ID
repository_full_namestringYes—Repository full name
actorstringYes—Actor who triggered workflow
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
completed_atstringNo—ISO timestamp
workflow_dispatch_processedstringNo—Whether dispatch was processed
organization_uuidstringNo—Organization UUID (public)
runner_execution_uuidstringNo—Runner execution UUID
runner_group_uuidstringNo—Runner group UUID
github_workflow_run_refintegerNo—Workflow run ID
repository_full_namestringNo—Repository full name
actorstringNo—Actor who triggered workflow
workflow_run_idstringNo—Parent DAG run ID
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

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"
  }
}