Skip to content
Proud to collaborate with Microsoft for Startups

github.check-complete ​

Complete check workflow

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
github_check_refintegerYes—GitHub check ID
check_namestringYes—Check name
check_statusstringYes—Check status
check_conclusionstringNo—Check conclusion
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
github_check_refintegerNo—GitHub check ID
check_namestringNo—Check name
check_statusstringNo—Check status
check_conclusionstringNo—Check conclusion
completed_atstringNo—Completion timestamp
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.check-complete",
  "initial_data": {
    "github_check_ref": 123,
    "check_name": "value",
    "check_status": "value"
  }
}