Skip to content
Proud to collaborate with Microsoft for Startups

github.deployment ​

Handles GitHub App deployment webhooks (DAG)

DAG-based GitHub deployment workflow.

Handles GitHub App deployment webhooks for audit logging. No model is created since deployments are informational only.

Overview ​

PropertyValue
Workflow typeDag
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)

Output Schema ​

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

DAG Layers ​

#LayerStepsCompensation
1validategithub.deployment-validate—
2sync_deploymentgithub.deployment-sync—
3completegithub.deployment-complete—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
github.deployment-validatevalidate
github.deployment-syncsync_deployment
github.deployment-completecomplete

Business Errors ​

CodeMessage Template
DELIVERY_ID_REQUIREDdelivery_ref is required
DEPLOYMENT_ID_REQUIREDdeployment.id not found in payload

API Usage ​

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

{
  "workflow_type": "github.deployment",
  "initial_data": {
    "delivery_ref": "value",
    "event_type": "value",
    "action": "value",
    "payload": "value"
  }
}