Skip to content
Proud to collaborate with Microsoft for Startups

github.workflow-job-validate ​

Validate and extract fields from workflow_job webhook payload

Validate and extract fields from a GitHub workflow_job webhook payload.

Inputs:

  • delivery_ref: Webhook delivery reference (required)
  • event_type: Webhook event type (required)
  • action: Webhook action (required)
  • payload: Full GitHub webhook payload (required)
  • organization_uuid: Public organization UUID (if already resolved)

Outputs (terminal state_data):

  • action: Job action (queued/in_progress/completed)
  • github_workflow_run_ref: GitHub workflow run reference the job belongs to
  • github_job_ref: GitHub workflow job reference
  • runner_name: Name of the runner that claimed the job (in_progress only)
  • runner_labels: Labels requested for the job
  • run_attempt: Run attempt number (1 for first attempt, >1 for retries)
  • repository_full_name: Full name "owner/repo"
  • organization_uuid: Resolved public organization UUID

Overview ​

PropertyValue
Workflow typeAtomic
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)
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
actionstringNo—Job action
github_workflow_run_refintegerNo—Workflow run reference
github_job_refintegerNo—Workflow job reference
runner_namestringNo—Runner name
runner_labelslistNo—Runner labels
run_attemptintegerNo—Run attempt number
repository_full_namestringNo—Repository full name
github_installation_refintegerNo—GitHub installation reference
delivery_refstringNo—Webhook delivery ID
event_typestringNo—Webhook event type
payloaddictNo—Webhook payload
organization_uuidstringNo—Organization UUID (public)
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-job-validate",
  "initial_data": {
    "delivery_ref": "value",
    "event_type": "value",
    "payload": "value"
  }
}