GitHub Trigger

Trigger workflows from GitHub App events. Events are delivered to your workflow's platform webhook URL and routed to the right workflow by GitHub App installation ID.

This is a GitHub App trigger — not a personal access token or a plain repository webhook. See the GitHub action plugin for token-based repository operations.

When to Use

Use GitHub Trigger when:

A push, pull request, or issue should kick off automation (CI summaries, notifications, label sync)
You want events across all repositories of a GitHub App installation, optionally filtered to one repo

Output

Handle	Type	Description
`payload`	object	Normalized GitHub App event payload

The payload (accessed as {{ github.* }}) shape:

Field	Type	Description
`type`	string	Full event type (e.g. `github.push`)
`event`	string	Event name (e.g. `push`, `pull_request`)
`action`	string	Event action, when the event has one (e.g. `opened`)
`installation_id`	string	GitHub App installation the event came from
`repository`	string	Repository full name (`owner/name`)

Settings

GitHub App

Setting	Type	Default	Description
`installation_id`	string	—	Required. Installation ID from the GitHub App install.
`repository`	string	—	Optional repository filter (`owner/name`). Empty = all repos for this installation.

Events

Setting	Type	Default	Description
`event_types`	multi-select	`push`, `pull_request`	Events that start a run: `push`, `pull_request`, `issues`, `issue_comment`, `release`, `workflow_run`.

Testing

Setting	Type	Default	Description
`mockPayload`	code editor (JSON)	sample `github.push` event	JSON payload injected for local test runs instead of a real GitHub event.

Example

Notify Slack on every push to the watched installation:

GitHub Trigger → Slack Send Message

GitHub Trigger settings:

Installation ID: 12345678
Repository: acme/app
Events: push

Slack Send Message settings:

Channel: #commits
Text: New push to {{ github.repository }} ({{ github.event }})