Skip to content
Proud to collaborate with Microsoft for Startups

github.workflow-run-complete ​

Record that workflow_run event was handled

Complete a workflow_run DAG — record that the event was handled.

Inputs:

  • action: The webhook action
  • github_workflow_run_ref: GitHub workflow run reference
  • repository_full_name: Full name "owner/repo"
  • run_status: Status from workflow_run
  • run_conclusion: Conclusion from workflow_run
  • organization_uuid: Organization UUID (public)
  • runner_stopped: Whether a runner was stopped
  • stop_reason: Why the runner was stopped (if applicable)

Outputs (terminal state_data):

  • completed_at: ISO timestamp
  • workflow_run_processed: True

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actionstringYes—Webhook action
github_workflow_run_refintegerNo—Workflow run ID
repository_full_namestringYes—Repository full name
run_statusstringNo—Workflow run status
run_conclusionstringNo—Workflow run conclusion
organization_uuidstringNo—Organization UUID (public)
runner_stoppedbooleanNo—Whether runner was stopped
stop_reasonstringNo—Why runner was stopped
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
completed_atstringNo—ISO timestamp
workflow_run_processedbooleanNo—Whether workflow_run was processed
actionstringNo—Webhook action
github_workflow_run_refintegerNo—Workflow run ID
repository_full_namestringNo—Repository full name
run_statusstringNo—Workflow run status
run_conclusionstringNo—Workflow run conclusion
organization_uuidstringNo—Organization UUID (public)
runner_stoppedbooleanNo—Whether runner was stopped
stop_reasonstringNo—Why runner was stopped
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-run-complete",
  "initial_data": {
    "action": "value",
    "repository_full_name": "value"
  }
}