github.workflow-dispatch-validate

Validate and extract fields from workflow_dispatch webhook payload

Validate and extract fields from a GitHub workflow_dispatch 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: Organization UUID (public) if already resolved

Outputs (terminal state_data):

• repository_full_name: Full name "owner/repo"
• github_repo_ref: GitHub repository reference
• actor: Username who triggered the workflow
• workflow_filename: Path to workflow file (e.g., .github/workflows/ci.yml)
• workflow_name: Name of the workflow
• workflow_inputs: Dictionary of workflow inputs from dispatch
• runner_group_uuid: Explicit runner_group_uuid from inputs (if provided)
• runner_labels: Requested runner labels from inputs (if provided)
• runner_image: Requested container image from inputs (if provided)
• github_workflow_run_ref: GitHub workflow run reference (if available in payload)
• github_installation_ref: GitHub installation reference for the repository
• organization_uuid: Resolved organization UUID (public)
• installation_uuid: Orkestia GitHubInstallation 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
repository_full_name	string	No	—	Repository full name
github_repo_ref	integer	No	—	GitHub repository reference
actor	string	No	—	Username who triggered the workflow
workflow_filename	string	No	—	Workflow file path
workflow_name	string	No	—	Workflow name
workflow_inputs	dict	No	—	Workflow inputs from dispatch
runner_group_uuid	string	No	—	Explicit runner group UUID
runner_labels	string	No	—	Requested runner labels
runner_image	string	No	—	Requested container image
github_workflow_run_ref	integer	No	—	GitHub workflow run reference
github_installation_ref	integer	No	—	GitHub installation reference
installation_uuid	string	No	—	GitHubInstallation UUID
delivery_ref	string	No	—	Webhook delivery ID
event_type	string	No	—	Webhook event type
action	string	No	—	Webhook action
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

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

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