GitHub
Connecting NeuBird with GitHub enables real-time insights into your repositories, allowing you to monitor pull requests, commits, and issues. The integration uses the NeuBird GitHub App, which you install on your personal or organization account.
Note: The connection dialog’s OAuth tab is the only way to install the NeuBird GitHub App for the first time. The Installation ID field is not a separate installation method — it only connects NeuBird to a NeuBird GitHub App that has already been installed (for example, by another teammate, or by you in a previous session). Use OAuth unless you already know the app is installed and just need its installation ID.
Step 1: Install the NeuBird app on GitHub
Section titled “Step 1: Install the NeuBird app on GitHub”-
Authenticate on GitHub: After initiating the connection, you will be redirected to GitHub to authenticate. If not already signed in, enter your GitHub credentials to proceed.
-
Select account for NeuBird app installation: Choose whether to install the NeuBird app on a Personal or Organization GitHub account. Select the desired account type, then click Continue.
-
Grant repository access: On the next page, choose the repositories that NeuBird should access:
- All repositories: NeuBird will monitor all repos in the selected account.
- Select repositories: Limit NeuBird’s access to specific repositories.
Choose the desired access level, then click Install.
-
Complete installation: After installation, you will be redirected back to the NeuBird dashboard, where a success message will confirm that the GitHub connection is now active.
Note: By installing the NeuBird app, you are agreeing to the preconfigured minimal permissions required for it to function. These permissions are designed to ensure that NeuBird can only access necessary data while maintaining your privacy and security.
For more information about GitHub apps and their permissions, see the GitHub documentation.
Note: If you don’t have permission to install apps on the GitHub organization you selected, GitHub won’t install the app immediately — it puts the installation into a requesting state pending approval from an organization owner or someone with app-management permissions. The OAuth flow will still redirect back and complete on the NeuBird side, but no connection is created, since there’s no installed app yet to connect to.
In this case, wait until an org owner approves the request and the app is actually installed. Once it is, switch to the Installation ID tab and connect using the now-installed app instead of repeating the OAuth flow:
- In GitHub, go to your organization’s Settings > GitHub Apps (or, for a personal account, Settings > Applications > Installed GitHub Apps) and find the NeuBird app.
- Click Configure. The page URL will contain the installation ID, e.g.
https://github.com/organizations/<org>/settings/installations/<installation_id>.- Copy that ID into the Installation ID field on the Installation ID tab when creating the connection.
Connection Fields
Section titled “Connection Fields”| Field | Required | Description |
|---|---|---|
| Name | Yes | A descriptive name for this GitHub integration |
| Description | No | Additional context about the connection |
| Installation ID | Yes (Installation ID tab only) | The installation ID of a NeuBird GitHub App that’s already installed on your account or organization |
For general instructions on creating and managing connections, see the Connections Overview.