Dispatch Repository Event
github.dispatch_repository_event
ActionBusiness appsconnection required
Calls the GitHub API POST /repos/{owner}/{repo}/dispatches.
Fire a repository_dispatch event so a workflow listening for it runs.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- GitHub
- Secret shape
- the GitHub personal access token
- Resolved by
- config.connection_id, else node.connection_id, else the tenant's sole GitHub connection
Configuration
4 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
owner Repository owner — the user or organisation login. Supports {{ }}. | string | Yes | — | — | octocat |
repo Repository name, without the owner prefix. Supports {{ }}. | string | Yes | — | — | hello-world |
event_type Name the workflow matches on, e.g. deploy. Max 100 characters. | string | Yes | — | ≤ 100 characters | deploy |
client_payload JSON object passed to the workflow as github.event.client_payload. GitHub allows at most 10 top-level keys and 64KB in total. | object | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"event_type": "deploy",
"owner": "octocat",
"repo": "hello-world"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when GitHub accepted the call. | boolean | true |
event_type The event name that was dispatched. | string | — |
{
"event_type": "",
"ok": true
}Notes
- GitHub answers 204 with no body — a successful dispatch says nothing about whether a workflow matched it.
Solutions with GitHub
See Dispatch Repository Event run in a workflow.
In a technical demo we add the GitHub connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.