Skip to main content

Source Control Integrations

.

GitHub

Experimental integration

This integration is currently in Experimental release status. The connection may be subject to significant changes and optimizations. We recommend using the integration in controlled testing environments.

Use the AI Incident Assistant GitHub integration to add code context or investigate recent code changes, pull requests, commits, and diffs.

Required Permissions

In GitHub, ensure the following personal access token (PAT) repository permissions are enabled:

  • Metadata 

  • Commit statuses 

  • Contents 

  • Issues 

  • Pull requests 

  • Checks 

Configure the GitHub Integration

To configure the integration, populate the following fields:

Field

Description

Authentication Method

Choose how you'd like to authenticate with this integration. The following methods are available:

  • Token (PAT) - Authenticate using a GitHub token (classic PAT or fine-grained PAT)

  • OAuth Access Token - Authenticate using a secure OAuth access token

  • GitHub App (Installation token) - Server-to-server auth via GitHub App JWT + installation access tokens

GitHub API Base URL

Enter the base URL of your GitHub instance. (for example, https://api.github.com)

Credentials

If you selected Token (PAT) as your authentication method, enter your Access Token.

If you selected OAuth Access Token as your authentication method, enter your OAuth Access Token.

If you selected GitHub App (Installation token) as your authentication method, enter your GitHub App ID, GitHub App Installation ID, and GitHub App Private Key (PEM).

Custom Headers (Optional)

Add custom HTTP headers to include with all API requests. For each header, include the Header Name and Header Value. To add additional headers, click the + sign.

Deployment Type

Select whether your GitHub integration is Cloud or On-Prem.

Certain integrations have endpoints that work only with one deployment type. Selecting the correct option automatically applies the right guardrails to the AI Incident Assistant agents.

Note: On-prem integrations can connect via the Relay Client, enabling secure communication with infrastructure behind your firewall.Remote Connections

GitHub System/Schema Nuances

List any special repo nuances, naming conventions, or other knowledge that helps AI Incident Assistant more effectively interact with your tool.

We highly recommend configuring this field, as it lets you enter organization-specific information that helps AI Incident Assistant provide more accurate and consistent results.

For example, you can enter key repos to prioritize, repo naming conventions, default branches, CI nuances, monorepo layout notes, deployment information, and any investigation playbooks that AI Incident Assistant should follow.

In this section: