Skip to content
Proud to collaborate with Microsoft for Startups

github.installation-validate ​

Validate required fields and determine sync type

Validate webhook payload and determine sync_type

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
delivery_refstringYes——
event_typestringYes——
actionstringNo——
payloaddictYes——
organization_uuidstringNo—Organization UUID (public)
workflow_run_idstringNo—Parent DAG run ID

Output Schema ​

FieldTypeRequiredDefaultDescription
delivery_refstringNo——
event_typestringNo——
actionstringNo——
payloaddictNo——
organization_uuidstringNo—Organization UUID (public)
github_installation_refintegerNo——
installation_datadictNo——
sync_typestringNo——
initiated_atstringNo——
failure_reasonstringNo——
workflow_run_idstringNo—Parent DAG run ID
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—run—
runNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingrunrun—
runcompletecompleted—
* (any state)failfailed—

Business Errors ​

CodeMessage Template
DELIVERY_ID_REQUIREDdelivery_ref is required
EVENT_TYPE_REQUIREDevent_type is required
PAYLOAD_REQUIREDpayload is required
INSTALLATION_ID_NOT_FOUNDinstallation.id not found in payload

API Usage ​

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

{
  "workflow_type": "github.installation-validate",
  "initial_data": {
    "delivery_ref": "value",
    "event_type": "value",
    "payload": "value"
  }
}