GitHub Integration

Connect your GitHub repository to Cheqpoint to auto-register AI Assistants from your code, link requests to commits, and require PR approvals before AI actions run.

cheqpoint.config.json

json

{
  "agents": [
    {
      "name": "finance-agent",
      "description": "Handles customer refunds and payouts",
      "actions": ["process_refund", "issue_payout"],
      "github_sync": true
    }
  ]
}

1. Agent Discovery

By adding a cheqpoint.config.json to your repository root, Cheqpoint can automatically register your AI Assistants and their allowed actions. This ensures your dashboard configuration always matches your source code.

2. PR & Commit Linking

Pass git metadata in your SDK calls to link approval requests directly to the code change that triggered them.

result = client.checkpoint(
    action="deploy_schema",
    summary="Migrating database schema",
    metadata={
        "pr_url": "https://github.com/org/repo/pull/42",
        "commit_sha": "a1b2c3d4"
    }
)

3. Gating on PR Status

A powerful security feature: require that a linked Pull Request must be Merged or have at least 2 approvals before the AI action can be approved in Cheqpoint.

Configure these rules in Dashboard → Agents → [Agent Name] → Safety Policies.

OAuth Setup

To enable the integration, you must configure a GitHub OAuth App in your workspace settings.

Callback URL: https://app.cheqpoint.co/api/auth/callback/github
Scopes: repo, read:org, read:user