Appearance
github.installation ​
Handles GitHub App installation webhooks (DAG)
DAG-based GitHub installation workflow.
Handles GitHub App installation webhooks with parallel-capable structure. Uses atomic workflows for step execution.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Dag |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | Yes | — | Webhook delivery ID |
event_type | string | Yes | — | Webhook event type |
action | string | No | — | Webhook action |
payload | dict | Yes | — | Webhook payload |
organization_uuid | string | No | — | Organization UUID (public) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | No | — | — |
event_type | string | No | — | — |
action | string | No | — | — |
payload | dict | No | — | — |
organization_uuid | string | No | — | — |
workflow_run_uuid | string | No | — | — |
validate | dict | No | — | — |
sync_installation | dict | No | — | — |
sync_repositories | dict | No | — | — |
complete | dict | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | integer | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
DAG Layers ​
| # | Layer | Steps | Compensation |
|---|---|---|---|
| 1 | validate | github.installation-validate | — |
| 2 | sync_installation | github.installation-sync-installation | — |
| 3 | sync_repositories | github.installation-sync-repositories | — |
| 4 | finalize | github.installation-complete | — |
Execution Flow ​
Sub-workflows ​
| Sub-workflow | Step name |
|---|---|
github.installation-validate | validate |
github.installation-sync-installation | sync_installation |
github.installation-sync-repositories | sync_repositories |
github.installation-complete | complete |
Business Errors ​
| Code | Message Template |
|---|---|
DELIVERY_ID_REQUIRED | delivery_ref is required |
EVENT_TYPE_REQUIRED | event_type is required |
PAYLOAD_REQUIRED | payload is required |
INSTALLATION_ID_NOT_FOUND | installation.id not found in payload |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.installation",
"initial_data": {
"delivery_ref": "value",
"event_type": "value",
"payload": "value"
}
}