Skip to content

GitHub Connection

Connect to GitHub using a Personal Access Token. This allows your workflows to interact with repositories, issues, pull requests, commits, and releases via the GitHub REST API.

Each connection targets one repository. To work with multiple repositories, create one GitHub connection per repo.

Configuration

FieldDescriptionRequired
Personal Access TokenA GitHub PAT (classic or fine-grained)Yes
Repository OwnerGitHub username or organization (e.g. octocat)Yes
RepositoryRepository name (e.g. hello-world)Yes
Base URLAPI base URL (default: https://api.github.com)No

The owner and repository are stored on the connection so the GitHub Trigger can auto-register a webhook on the repo when the connection is created, and so every GitHub API node sharing this connection operates on the same repository.

GitHub Enterprise

If you use GitHub Enterprise Server, set the Base URL to your instance's API endpoint, e.g. https://github.yourcompany.com/api/v3.

Creating a Personal Access Token

Classic Token

  1. Go to Settings > Developer settings > Personal access tokens > Tokens (classic)
  2. Click Generate new token (classic)
  3. Select the scopes your workflows need:
    • repo for private repository access
    • public_repo for public repository access only
    • admin:repo_hook if you'll use the GitHub Trigger (needed to register webhooks)
  4. Copy the generated token (starts with ghp_)

Fine-Grained Token

  1. Go to Settings > Developer settings > Personal access tokens > Fine-grained tokens
  2. Click Generate new token
  3. Select the repository access and permissions your workflows need
  4. Copy the generated token (starts with github_pat_)

Usage

Once created, this connection becomes available in:

  • GitHub API — list, get, create, update, and comment on issues, pull requests, commits, and releases

Rate Limits

Authenticated requests allow up to 5,000 requests per hour. The GitHub API node automatically retries when rate-limited (HTTP 429 or 403 with exhausted limits) with exponential backoff.