github.workflow-job-validate ​
Validate and extract fields from workflow_job webhook payload
Validate and extract fields from a GitHub workflow_job webhook payload.
Inputs:
- delivery_ref: Webhook delivery reference (required)
- event_type: Webhook event type (required)
- action: Webhook action (required)
- payload: Full GitHub webhook payload (required)
- organization_uuid: Public organization UUID (if already resolved)
Outputs (terminal state_data):
- action: Job action (queued/in_progress/completed)
- github_workflow_run_ref: GitHub workflow run reference the job belongs to
- github_job_ref: GitHub workflow job reference
- runner_name: Name of the runner that claimed the job (in_progress only)
- runner_labels: Labels requested for the job
- run_attempt: Run attempt number (1 for first attempt, >1 for retries)
- repository_full_name: Full name "owner/repo"
- organization_uuid: Resolved public organization UUID
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| 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) |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | No | — | Job action |
github_workflow_run_ref | integer | No | — | Workflow run reference |
github_job_ref | integer | No | — | Workflow job reference |
runner_name | string | No | — | Runner name |
runner_labels | list | No | — | Runner labels |
run_attempt | integer | No | — | Run attempt number |
repository_full_name | string | No | — | Repository full name |
github_installation_ref | integer | No | — | GitHub installation reference |
delivery_ref | string | No | — | Webhook delivery ID |
event_type | string | No | — | Webhook event type |
payload | dict | No | — | Webhook payload |
organization_uuid | string | No | — | Organization UUID (public) |
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 | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.workflow-job-validate",
"initial_data": {
"delivery_ref": "value",
"event_type": "value",
"payload": "value"
}
}