Skip to content
Proud to collaborate with Microsoft for Startups

github.deployment-validate ​

Validate deployment event payload and extract deployment data

Validate deployment webhook payload and extract data

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
delivery_refstringYes—Webhook delivery ID
event_typestringYes—Webhook event type
actionstringYes—Webhook action
payloaddictYes—Webhook payload
organization_uuidstringNo—Organization UUID (public)
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
delivery_refstringNo—Webhook delivery ID
event_typestringNo—Webhook event type
actionstringNo—Webhook action
github_deployment_refintegerNo—GitHub deployment ID
deployment_datadictNo—Deployment data
status_datadictNo—Deployment status data
repository_uuiduuidNo—Repository UUID
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.deployment-validate",
  "initial_data": {
    "delivery_ref": "value",
    "event_type": "value",
    "action": "value",
    "payload": "value"
  }
}