Skip to main content
Administrators set up GitHub once for the Cake Agents environment. Individual users then link their own GitHub accounts separately.

​
What This Enables

GitHub setup allows Cake Agents to:
  • open pull requests
  • push commits on behalf of linked users
  • use GitHub-backed workflows inside sessions

​
Admin Responsibilities

As an admin, you are responsible for:
  • registering the GitHub App used by Cake Agents
  • configuring the app so the control plane can complete the user linking flow
  • ensuring the environment can store the app credentials securely

​
Requirements

You must be an organization-level admin on GitHub to proceed.

​
Instructions

​
Register the GitHub App

  1. In Cake Agents, go to Settings → Organization → Integrations.
  2. Next to GitHub, select Connect.
  3. Enter the name of your GitHub organization. We will use this to create a GitHub App for your organization’s instance of Cake Agents.
  4. Click “Continue to GitHub”.
  5. For “GitHub App name” append your company name. For example “Cake Agents - ACME Corp”.
  6. Click “Create GitHub App for <your org>

​
Install the GitHub App

  1. Back in Cake Agents, navigate to Settings → Organization → Integrations and select Connect next to GitHub.
  2. Click “Continue to GitHub”.
  3. Select the repositories you’d like to enable (this can be changed later), then click “Install”.

​
Webhook events

The GitHub App that Cake Agents registers sends repository webhook events, such as CI results and pull request activity, to Cake Agents. Agents use these events to watch CI and react to GitHub activity inside sessions. If your deployment disables public ingress, Cake Agents registers the App without a webhook or event subscriptions. The GitHub settings page shows External webhooks are disabled instead of the webhook configuration status. Apps registered before webhook support might not subscribe to these events. If an agent reports that the App doesn’t subscribe to a requested event, enable that event on the App’s Permissions & events page in GitHub.

​
Webhook configuration sync

When you open the GitHub settings under Settings → Organization → Integrations, Cake Agents checks the App’s webhook configuration on GitHub. If the webhook URL, content type, or secret differs from what Cake Agents expects, Cake Agents updates them on GitHub automatically. This keeps deliveries working after your deployment URL changes. The page shows one of the following states: Cake Agents can’t change some settings because GitHub doesn’t expose them through its API. Set these manually in the App’s settings on GitHub:
  • the webhook Active checkbox
  • event subscriptions on the Permissions & events page
  • SSL verification. Cake Agents shows a warning if SSL verification is disabled.

​
Test the integration

You can test the integration by linking your GitHub account to your Cake Agents user and verifying that the New Session page shows all the expected GitHub repos.