Skip to main content

GitHub Trigger

Two separate trigger nodes cover polling and webhook-based activation.

GitHub Poll Trigger​

Type ID: githubPollTrigger  ·  Kind: Trigger (poll)

Checks a repository on a schedule for newly created pull requests or issues.

Credentials​

GitHub

Properties​

PropertyKeyTypeRequiredDefaultPossible values
OwnerownerstringYes''Repository owner
RepositoryrepostringYes''Repository name
WatchwatchoptionsYespullRequestPull Requests (pullRequest), Issues (issue)
Poll IntervalpollIntervalMsnumberYes90000Defines the interval, in milliseconds, at which GitHub is checked for new pull requests or issues. A minimum polling interval of 90 seconds is enforced; any value below 90,000 ms will default to 90,000 ms

Notes​

  • New items are detected by comparing each item's creation time against the configured poll interval; GitHub's pull request and issue listing endpoints have no server-side time filter.
  • If a burst of activity means the newest page of results doesn't reach back far enough to cover the full poll interval, the trigger automatically fetches additional pages (newest first) until it finds items older than the window, up to a safety cap of 20 pages per poll.
  • Output: { watch, count, items: [...], polledAt, hitPageCap }. hitPageCap is true if the 20-page safety cap was reached before the window boundary was found — meaning some matching items from this poll interval may not be included. This can be true even when items is empty (e.g. a burst of activity was entirely pull requests while watching issues).
  • Watching Issues excludes pull requests, since GitHub's issues endpoint returns both.

GitHub Webhook Trigger​

Type ID: githubWebhookTrigger  ·  Kind: Trigger (webhook)

Starts a workflow when GitHub sends a webhook event to this workflow's generated URL.

Credentials​

GitHub Webhook

Properties​

PropertyKeyTypeRequiredDefaultPossible values
HTTP MethodmethodstringYesPOSTPOST

Notes​

  • Verifies the X-Hub-Signature-256 header against the configured webhook secret before processing any event.
  • GitHub's automatic ping event (sent when a webhook is first registered) produces a successful run with no output.
  • Output for other events: { event, deliveryId, payload, receivedAt }, where payload is the full GitHub webhook payload for that event type.
  • Registering the webhook URL and secret on GitHub's side is a manual step, done once per repository.