Skip to content

GitHub Trigger

Triggers a workflow when events occur in a GitHub repository. The webhook is automatically registered with GitHub when the workflow is published — no manual setup required.

Requires a GitHub connection with a token that has the admin:repo_hook scope.

Configuration

FieldDescriptionNotes
ConnectionGitHub connection to use. The repository to watch is defined on the connection.Required
EventsWhich events to listen forRequired. Multiple selection

Supported Events

EventDescription
pushPush to any branch
pull_requestPull request opened, closed, merged, etc.
issuesIssue opened, closed, edited, etc.
issue_commentComment on an issue or PR
createBranch or tag created
deleteBranch or tag deleted
releaseRelease published, created, etc.
workflow_runGitHub Actions workflow completed
starRepository starred
forkRepository forked

Output

The trigger passes the full GitHub webhook payload to downstream nodes. Key fields include:

FieldDescription
body.actionEvent action (e.g., opened, closed, created)
body.senderGitHub user who triggered the event
body.repositoryRepository details
headers.X-GitHub-EventEvent type name

How It Works

  1. You pick the GitHub connection (which carries the repository) and select which events to listen for
  2. The webhook is auto-registered on that repository when the connection is created, and shared by every workflow whose GitHub Trigger uses this connection
  3. GitHub sends every event for the repository to a single connection-scoped webhook URL; each trigger node filters by its configured event list
  4. Deleting the connection unregisters the webhook in GitHub

Required Token Scope

Your GitHub personal access token must include the admin:repo_hook scope to create and manage webhooks. Without this scope, webhook registration will fail silently and the trigger won't receive events.