GitHub Setup Guide
Follow our setup guide to connect GitHub to Fivetran.
Prerequisites
To connect GitHub to Fivetran, you need:
- access to an active GitHub account with the appropriate permissions or GitHub App installation.
Use only an HTTPS URL with TLS version 1.2 or higher.
Setup instructions
Configure GitHub for authentication
Follow the configuration instructions for your chosen authentication method.
OAuth
You will configure OAuth during the connection setup process in the Fivetran dashboard.
The following scopes are required by OAuth App:
reporead:orgproject:readadmin:org_hookadmin:repo_hook
Set the Use Webhooks toggle to ON to use webhooks.
Webhooks are not supported with Hybrid Deployment.
See the GitHub Scopes For OAuth Apps documentation for details.
Personal Access Token (PAT)
Create personal access tokens using multiple GitHub accounts to avoid rate limiting. Ideally, use 4–5 tokens from different users.
Grant the necessary scopes to each classic token:
reporead:orgproject:readmanage_billing:copilotread:enterprise
Optionally, to use webhooks:
admin:org_hookadmin:repo_hook
If using fine-grained personal access tokens, configure the following:
- Grant all the necessary permissions to sync the desired tables based on the link above. All the tables you want to sync must have
readaccess. - Disable deprecated tables in the connection's Schema tab:
CARD,COLUMN,PROJECT. They are not supported with fine-grained tokens. - Disable unsupported table
COMMIT_CHECK_RUN. Fine-grained tokens don't provide permissions to sync commit checks. - Optionally, to use webhooks, grant Organization hooks:
writeand Repository hooks:writepermissions.
- Grant all the necessary permissions to sync the desired tables based on the link above. All the tables you want to sync must have
(Optional) To connect GitHub Enterprise Server, set the On Premise toggle to ON, and then in the Host field, enter your instance URL.
Set the Use Webhooks toggle to ON to use webhooks.
Webhooks are not supported with Hybrid Deployment.
GitHub App
Create a new GitHub App.
Set the Repository and Organization permissions based on GitHub App permissions documentation
- All the tables you want to sync must have
readaccess.
- All the tables you want to sync must have
Install the GitHub App on your organization or account from your GitHub App’s installation page.
Only one installation per GitHub App is supported.
Generate a private key for your GitHub App.
Finish Fivetran configuration
In the Fivetran connection setup form, enter your chosen Destination schema name.
(Hybrid Deployment only) If your destination is configured for Hybrid Deployment, the Hybrid Deployment Agent associated with your destination is pre-selected for the connection. To assign a different agent, click Replace agent, select the agent you want to use, and click Use Agent.
Select your Authentication Mode:
Using OAuth
Click Authorize. This redirects you to GitHub.
In GitHub, log in. We recommend logging in using Incognito mode to ensure you're authorizing the correct account.
Click Authorize Fivetran and enter your GitHub password if prompted.
GitHub redirects you back to the Fivetran connection setup form, where the authentication is now complete.
To sync
COPILOT_METRICandCOPILOT_METRIC_TEAMtables, make sure your OAuth app tokens include either themanage_billing:copilotandread:orgor theread:enterprise.
Using PAT
- Under Personal Access Tokens, click + Add.
- Add one or more valid personal access tokens. You can add multiple tokens.
- Click Validate personal access tokens. Fivetran will validate the tokens after submission.
Use tokens from multiple GitHub accounts (ideally 4–5) to avoid hitting GitHub's rate limits.
Using GitHub App
Enter your GitHub App Client ID.
Upload the Private Key associated with your GitHub App.
Once complete, Fivetran uses these credentials to authenticate the GitHub App.
You must install the GitHub App in your organization or account before completing this step.
Choose whether to:
- Sync All Repositories, or
- Sync Specific Repositories (requires manual permission configuration).
Click Save & Test. Fivetran will verify the connection and begin syncing your GitHub data.
Related articles
description Connector Overview
account_tree Schema Information