Event
trigger.github_event
TriggerBusiness appsconnection requiredruns in-engine
Registers a GitHub webhook on publish; one run per delivery, deduped on X-GitHub-Delivery.
Start a run when a GitHub repository or organization event fires.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- GitHub
- Secret shape
- {"token"} — a PAT with admin:repo_hook (or admin:org_hook)
- Resolved by
- config.connection_id, else the tenant's sole github connection
Configuration
4 fields, none 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 (user or org). Required with 'repo'. | string | No | — | — | — |
repo Repository name. Leave blank for an organization-wide hook. | string | No | — | — | — |
org Organization login, for a hook covering every repository in it. Leave blank when 'repo' is set. | string | No | — | — | — |
events GitHub events to subscribe to, e.g. push, pull_request, issues, issue_comment. Use ['*'] for every event. Defaults to ['push'], as GitHub does. | array | No | ["push"] | ≥ 1 characters; array of string | — |
- At least one of repo, org must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"events": [
"push"
]
}Output
One shape.
event
| Field | Type | Example |
|---|---|---|
event The GitHub event name (X-GitHub-Event). | string | pull_request |
action The event's action, or '' for events that have none. | string | opened |
repository.full_name | string | acme/app |
repository.id | number | — |
sender.login The GitHub user who caused the event. | string | octocat |
sender.id | number | — |
delivery_id X-GitHub-Delivery; the run's idempotency key. | string | — |
payload GitHub's webhook body, unchanged — every event-specific field. | object | — |
{
"action": "opened",
"delivery_id": "",
"event": "pull_request",
"payload": {},
"repository": {
"full_name": "acme/app",
"id": 0
},
"sender": {
"id": 0,
"login": "octocat"
}
}Notes
- The hook is created at publish and deleted on unpublish, disable or archive.
- Deliveries are verified against X-Hub-Signature-256 before a run can start.
- Redeliveries reuse the first run — one run per X-GitHub-Delivery.
- owner/repo/org/events are read at publish time and cannot be {{ expressions }}.
Solutions with GitHub
See 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.