github.actions.trigger_workflow

Trigger a GitHub Actions workflow_dispatch run through an installed GitHub App connection.

Overview

Property	Value
Workflow type	Atomic
Library	App-github
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Organization UUID
actor	string	No	—	Actor initiating the workflow
workflow_run_id	string	No	—	Parent workflow run id
dry_run	boolean	No	—	Validate and plan without calling GitHub
repository	string	Yes	—	Repository owner/name
workflow	string	Yes	—	Workflow file name (e.g. build-and-push-images.yml) or numeric workflow id
ref	string	No	—	Git ref (branch or tag) to run from; defaults to the repo's default branch
inputs	dict	No	—	workflow_dispatch inputs (JSON object) passed to the run

Output Schema

Field	Type	Required	Default	Description
status	string	No	—	planned, dispatched, or failed
repository	string	No	—	—
workflow	string	No	—	—
ref	string	No	—	—
inputs	dict	No	—	—
applied	boolean	No	—	—
dry_run	boolean	No	—	—
warnings	list	No	—	—
failure_reason	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—
failed_at	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.actions.trigger_workflow",
  "initial_data": {
    "organization_uuid": "value",
    "repository": "value",
    "workflow": "value"
  }
}