Appearance
github.push-validate ​
Validate push event payload and extract branch/commit info
Validate push webhook payload and extract data
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| 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 |
payload | dict | Yes | — | Webhook payload |
organization_uuid | string | No | — | Organization UUID (public) |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
delivery_ref | string | No | — | — |
github_repo_ref | integer | No | — | — |
repository_uuid | string | No | — | — |
organization_uuid | string | No | — | — |
ref | string | No | — | — |
branch_name | string | No | — | — |
head_commit | dict | No | — | — |
commits | list | No | — | — |
pusher | dict | No | — | — |
is_deleted | boolean | No | — | — |
is_created | boolean | No | — | — |
is_forced | boolean | No | — | — |
before_sha | string | No | — | — |
after_sha | string | No | — | — |
workflow_run_id | string | No | — | Parent DAG run ID |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
executing | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | executing | — |
executing | complete | completed | — |
* (any state) | fail | failed | — |
Business Errors ​
| Code | Message Template |
|---|---|
REPOSITORY_NOT_FOUND | GitHub repository not found |
REF_REQUIRED | ref is required |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.push-validate",
"initial_data": {
"delivery_ref": "value",
"event_type": "value",
"payload": "value"
}
}