Skip to content
Proud to collaborate with Microsoft for Startups

github.workflow-job ​

Handle GitHub workflow_job webhook events — confirm runner claim

DAG-based GitHub workflow_job handler.

Routes workflow_job: in_progress events to runner.execution-claim-watch so the system knows the runner agent registered and claimed the job.

Overview ​

PropertyValue
Workflow typeDag
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
delivery_refstringYes—Webhook delivery ID
event_typestringYes—Webhook event type
actionstringNo—Webhook action
payloaddictYes—Webhook payload
organization_uuidstringNo—Organization UUID (public)

Output Schema ​

FieldTypeRequiredDefaultDescription
delivery_refstringNo——
event_typestringNo——
actionstringNo——
payloaddictNo——
organization_uuidstringNo——
workflow_run_uuidstringNo——
validatedictNo——
handledictNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerintegerNo——
errorstringNo——
error_typestringNo——

DAG Layers ​

#LayerStepsCompensation
1validategithub.workflow-job-validate—
2handlegithub.workflow-job-handle—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
github.workflow-job-validatevalidate
github.workflow-job-handlehandle

Business Errors ​

CodeMessage Template
WORKFLOW_JOB_ERRORAn unknown error occurred

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "github.workflow-job",
  "initial_data": {
    "delivery_ref": "value",
    "event_type": "value",
    "payload": "value"
  }
}