Skip to content
Proud to collaborate with Microsoft for Startups

github.workflow-run-validate ​

Validate and extract fields from workflow_run webhook payload

Validate and extract fields from a GitHub workflow_run 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: Organization UUID (public) if already resolved

Outputs (terminal state_data):

  • github_workflow_run_ref: GitHub workflow run reference
  • repository_full_name: Full name "owner/repo"
  • github_repo_ref: GitHub repository reference
  • actor: Username who triggered the workflow
  • run_status: Status from workflow_run (e.g., "completed")
  • run_conclusion: Conclusion from workflow_run (e.g., "success", "failure")
  • 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
github_workflow_run_refintegerNo—GitHub workflow run reference
repository_full_namestringNo—Repository full name
github_repo_refintegerNo—GitHub repository reference
actorstringNo—Username who triggered the workflow
run_statusstringNo—Workflow run status
run_conclusionstringNo—Workflow run conclusion
delivery_refstringNo—Webhook delivery ID
event_typestringNo—Webhook event type
actionstringNo—Webhook action
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-run-validate",
  "initial_data": {
    "delivery_ref": "value",
    "event_type": "value",
    "payload": "value"
  }
}