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 useRequired
Repository OwnerGitHub username or organizationRequired
RepositoryRepository nameRequired
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 configure the trigger with a repository and events
  2. When you publish the workflow, the system automatically creates a webhook in your GitHub repository
  3. When you re-publish or delete the workflow, the old webhook is cleaned up and a new one is registered
  4. GitHub sends event payloads to your workflow's unique webhook URL

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.