Skip to content
Proud to collaborate with Microsoft for Startups

github.pull_request ​

Handles GitHub App pull_request webhooks (DAG)

DAG-based GitHub pull_request workflow.

Handles GitHub App pull_request webhooks for audit logging. No model is created since PRs 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_prdictNo——
dispatch_staff_eventdictNo——
completedictNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerintegerNo——
errorstringNo——
error_typestringNo——

DAG Layers ​

#LayerStepsCompensation
1validategithub.pull_request-validate—
2sync_prgithub.pull_request-sync—
3dispatch_staff_eventstaff.dispatch-event-to-actor—
4completegithub.pull_request-complete—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
github.pull_request-validatevalidate
github.pull_request-syncsync_pr
staff.dispatch-event-to-actordispatch_staff_event
github.pull_request-completecomplete

Business Errors ​

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

API Usage ​

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

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