Guide

Add Connector Github

Overview

Airbyte is a data integration platform that allows you to connect various data sources to your workflows. By adding a GitHub connector credential, you enable Airbyte's Agent Engine to fetch, search, and work with data from your GitHub repositories in real time. This is essential if you want your agents to have access to GitHub issues, commits, or repository metadata as part of their context. The connector acts as a secure bridge between Airbyte and GitHub, handling authentication once so you can reuse it across multiple connections without re-entering credentials.

Before you begin

  • An active Airbyte account with access to app.airbyte.ai
  • A GitHub account (personal or organization) with repositories you wish to sync
  • GitHub account owner or admin permissions to authorize third-party applications
  • Access to the Credentials section in Airbyte (typically available in all workspace roles)

Step by step

1
ClickCredentials

Navigate to the Credentials section of Airbyte by clicking the Credentials link in the left navigation menu. This is where all stored credential configurations across your workspaces are managed.

Tip. The Credentials section is a central hub for managing all connector credentials. You can view, update, and reuse credentials here without re-authenticating.
Step 1
2
ClickAdd Credential

Click the 'Add Credential' button to begin creating a new connector credential. This opens the connector selection interface.

Step 2
3
ClickOrganization Browzer Get Started Dashboard Credentials Chat with your Agent Help Account Billing Dark mode Credentials Registered credentials across all workspaces Add Credential All workspaces All connectors Add credentials directly from this page o

Wait for the credential creation page to fully load, which displays all available connector options and a workspace filter. This ensures the interface is ready for your selection.

Tip. You may see a loading state or see the page re-render. This is normal. The page will display 'All workspaces' and 'All connectors' filters at the top.
Step 3
4
ClickGitHub

Click the 'GitHub' button to select GitHub as the connector type you want to add. This initiates the GitHub-specific credential workflow.

Tip. Look for the GitHub logo or label among the connector options. If you have many connectors, you can use the search or filter to find GitHub quickly.
Step 4
5
ClickAuthenticate your GitHub account

Click the 'Authenticate your GitHub account' button to start the OAuth authentication flow. This redirects you to GitHub to grant Airbyte permission to access your account and repositories.

Tip. Ensure your browser allows pop-ups for app.airbyte.ai, as the GitHub login window may open in a new tab or modal.
Step 5
6
Switch Tab

Your browser switches to the GitHub authentication tab. This tab contains the GitHub login form and authorization request from Airbyte.

Tip. If you are already logged into GitHub, you may skip the login step and see the authorization request immediately.
7
Navigate

The page navigates to github.com, where you are prompted to log in (if not already logged in) or to review the permissions Airbyte is requesting. Verify the account name and organization memberships shown.

Tip. The authorization screen will show you exactly which scopes (permissions) Airbyte is requesting, such as access to repositories and commit history. Review this carefully before proceeding.
8
ClickAuthorize

Click the 'Authorize' button on the GitHub authorization page to grant Airbyte permission to access your GitHub account and repositories. This completes the OAuth handshake.

Tip. After clicking, GitHub will display a confirmation message and prepare to redirect you back to Airbyte. This may take a few seconds.
Warning. Once you authorize, Airbyte gains ongoing access to your GitHub data according to the requested scopes. You can revoke this access at any time in GitHub Settings > Applications > Authorized OAuth Apps.
Step 8
9
Navigate

GitHub processes your authorization and prepares to redirect you back to Airbyte. The page may show a success message or brief redirect screen.

Tip. Do not close the tab or navigate away. Let the redirect complete automatically.
10
Navigate

You are automatically redirected back to app.airbyte.ai after GitHub confirms your authorization. The page now displays the connector configuration form with your GitHub account linked.

Tip. If you are not automatically redirected after 15 seconds, manually switch back to the Airbyte tab and refresh the page. Your authorization should still be valid.
11
Clickgeneric

The connector configuration panel is now visible and ready for input. This panel allows you to select repositories and configure sync behavior.

Tip. The page may appear to load or re-render briefly as it retrieves your GitHub repositories. Patience here ensures all repositories are available for selection.
Step 11
12
TypeGitHub Repositories

Click on the 'GitHub Repositories' dropdown menu (combobox) to view and select which repositories you want to sync through this connector. You can select one or multiple repositories.

Tip. You can start typing a repository name to filter the list. The dropdown will show both personal repositories and organization repositories you have access to.
13
Clickgeneric

After selecting your desired repositories from the dropdown, confirm the selection by clicking in the designated area or pressing Enter. The selected repositories are now active for this connector.

Tip. You can select multiple repositories by clicking each one. A checkmark or highlight will indicate selected items. You can change this selection at any time.
Step 13
14
ClickInclude Commits

Check the 'Include Commits' checkbox to enable syncing of commit history from your selected repositories. This allows Airbyte to fetch commit metadata and messages alongside repository data.

Tip. Including commits increases the volume of data synced and may impact sync performance. Only enable this if your agents or downstream processes need commit-level information.
Step 14
15
ClickOrg Repositories

Click on 'Org Repositories' to filter the repository list to show only repositories that belong to organizations you are a member of, rather than personal repositories. This narrows your selection scope.

Tip. This is optional. You can leave this unchecked to see all repositories (personal and organization) you have access to. Toggle it based on your data source needs.
Step 15
16
ClickSave

Click the 'Save' button to finalize and store your GitHub connector credential configuration. This saves your authentication token and repository selections for future use.

Tip. After saving, you will see a success message and the credential will appear in your Credentials list. You can now use this credential to create data connections from GitHub to your destinations.
Warning. Ensure you have selected at least one repository before clicking Save, otherwise the save may fail. If you need to change repositories later, you can edit this credential and update the selection.
Step 16

Confirm it worked

  1. 1After saving, the GitHub connector credential appears in the Credentials list on app.airbyte.ai with a success status
  2. 2You can create a new source connection using the saved GitHub credential without re-authenticating
  3. 3The configured repositories are selectable in subsequent connection setup steps
  4. 4Commits are flagged as included in the connector settings if you enabled the 'Include Commits' option

Common issues

Keep reading