User Guide/Integrations
Integrations

How to Create a GitHub Credential

Prepare a GitHub token for GitHub-backed sources and other GitHub integrations in Cortex.

What This Credential Is For

Use a GitHub credential when Cortex needs to query GitHub on your behalf, such as polling repository releases or other repository activity through the GitHub API.

What To Create In GitHub

Create a GitHub personal access token before you add the credential in Cortex.

Note

In the coding-agent knowledge-base example, we assume the repositories being monitored are public. The token is therefore mainly used for reliable GitHub API access and rate-limit headroom, not for private repository access.

How To Add It In Cortex

  1. Create the GitHub token in GitHub.
  2. Open the relevant credential-management surface in Cortex once GitHub credentials are supported there.
  3. Store the token as a GitHub credential for your organization.
  4. Reference that credential from the source or integration that needs GitHub access.

How Cortex Uses It

Cortex should use the credential when making outbound GitHub API requests for sources or other GitHub-backed integrations. The same credential can be used across multiple sources that need access to the same GitHub account context.

Status

GitHub credential support for generic API endpoint sources is still under design. Use this guide as the current setup reference for GitHub-backed Cortex features.