> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/github.md).

# GitHub

## OAuth app properties

| Property                | Value                                                                                                                                                                                                                     |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Multi-tenant**        | **Yes.** Any GitHub user can authorize one OAuth app. Access to an organization's private resources needs that organization's approval, see Limitations.                                                                  |
| **Vendor review**       | **None.**                                                                                                                                                                                                                 |
| **Review time**         | Not applicable.                                                                                                                                                                                                           |
| **Users before review** | No limit.                                                                                                                                                                                                                 |
| **App owner**           | A personal GitHub account or an organization.                                                                                                                                                                             |
| **Regions**             | One app on github.com. The connector calls `api.github.com`, so GitHub Enterprise Server and GHE.com (data residency) accounts cannot connect through it.                                                                 |
| **Client secret**       | No expiry documented. You can generate a new one in the app settings.                                                                                                                                                     |
| **Rate limits**         | 5,000 requests per hour per user, shared with the user's other apps and tokens (15,000 for members of a GitHub Enterprise Cloud organization that owns or approved the app). 2,000 OAuth token requests per hour per app. |
| **Checked**             | 2026-11-13                                                                                                                                                                                                                |

**Limitations**

* OAuth app access restrictions are on by default for new organizations. Until an organization owner approves the app, the connector reads public data only and writes into the organization's repositories fail with `403`.
* GitHub keeps at most 10 tokens per user, app and scope set. When the same GitHub user connects an 11th time, GitHub revokes an older token and the account that used it stops working.
* GitHub revokes a token that has not been used for one year. The user then connects the account again.
* The user's 5,000 requests per hour are shared with every other app and personal token the user has, so a busy flow can run out of quota because of other tools.

Sources: [Authorizing OAuth apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps), [Token expiration and revocation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation), [OAuth app access restrictions](https://docs.github.com/en/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions), [REST API rate limits](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## Register OAuth app

Go to **GitHub → Settings → Developer settings → OAuth Apps → New OAuth App** (for an organization-owned app: **Organization settings → Developer settings → OAuth Apps**).

* **Application name** and **Homepage URL**: anything your users should recognise.
* **Authorization callback URL**: `https://<your-appmixer-api>/auth/github/callback` — replace the host with your Appmixer API URL and keep the suffix `/auth/github/callback`.

Generate a client secret and create the `appmixer:github` configuration in the [Backoffice](https://docs.appmixer.com/getting-started/services) with `clientId` and `clientSecret`.

{% hint style="info" %}
If the GitHub organization your users work with restricts third-party OAuth app access (**Organization settings → Third-party access → OAuth app policy**), an organization owner has to approve the Appmixer app there. Until then the connector reads public data but every write into the organization's repositories fails with `403 — OAuth App access restrictions`.
{% endhint %}

## Organization webhook for the board and Dependabot triggers

Two triggers receive their events through an **organization webhook**:

* **On Project Item Changed**: `projects_v2_item` events, fired when a card on a Projects (v2) board changes its Status or another field.
* **On Dependabot Alert**: `dependabot_alert` events, fired when Dependabot opens, reintroduces, reopens, fixes or dismisses a vulnerability alert in a repository of the organization.

Neither trigger registers anything on GitHub itself. GitHub delivers these events only through an organization webhook, and only an organization owner can manage those. An owner therefore creates the webhook once per organization, and every flow with either trigger subscribes to it through the connector. Both triggers share the same webhook, URL and secret.

### 1. Give the connector a webhook secret

Add a `webhookSecret` key to the `appmixer:github` configuration in the [Backoffice](https://docs.appmixer.com/getting-started/services), or with the CLI:

```bash
appmixer service-config set appmixer:github -u -d '{"webhookSecret": "<secret>"}'
```

Any long random string works — for example the output of `openssl rand -hex 32`. GitHub signs every delivery with it (`X-Hub-Signature-256`) and the connector drops deliveries whose signature does not match.

### 2. Create the organization webhook

As an owner of the organization, open **Organization settings → Webhooks → Add webhook** and fill in:

* **Payload URL**: `https://<your-appmixer-api>/plugins/appmixer/github/events`
* **Content type**: `application/json`
* **Secret**: the same value as `webhookSecret`
* **SSL verification**: enabled
* **Which events would you like to trigger this webhook?**: *Let me select individual events* → tick **Project v2 items** for On Project Item Changed and **Dependabot alerts** for On Dependabot Alert. Tick only the events your flows use.

If the organization already has the webhook for one of the triggers, don't create a second one. Open the existing webhook (**Organization settings → Webhooks → Edit**), tick the other event and save.

![Adding the organization webhook](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-ce04563f088842206ac9629dbd859881505fbe26%2Fgithub-org-webhook.png?alt=media)

The screenshot shows `https://acme.appmixer.ai/…` as an example: put your own Appmixer API URL in front of `/plugins/appmixer/github/events` (the same host your Appmixer API answers on, for example `https://api.acme.appmixer.cloud/plugins/appmixer/github/events`).

Save it. GitHub immediately sends a `ping`, which the connector answers with `200`; you can see it under **Recent Deliveries** of the webhook. One webhook serves every flow on the Appmixer instance.

{% hint style="warning" %}
**Appmixer connected to an Auth Hub.** When your Appmixer instance authenticates GitHub through an Auth Hub, the trigger's subscription lives on the hub, so the **Payload URL must be the hub's endpoint**: `https://<your-auth-hub>/plugins/appmixer/github/events`. The GitHub connector must be installed on the hub and the `webhookSecret` set in the hub's `appmixer:github` configuration. The hub relays every delivery to the subscribed flows of the connected instances.
{% endhint %}

### 3. Use the triggers

**On Project Item Changed.** In the flow, set the trigger's **Organization** (the login of the organization) and optionally **Project Node ID** (the GraphQL node id of one board, `PVT_…`; leave it empty to receive events of every board of the organization). The account bound to the trigger needs only the `read:org` and `read:project` scopes — they serve Flow Test Mode, which reads the newest card of the board.

**On Dependabot Alert.** Set **Organization**. You can narrow what the trigger emits with these optional fields:

* **Repository**: `api-server` or `acme/api-server`. Leave it empty to watch every repository of the organization.
* **Actions**: defaults to Created, Reintroduced, Reopened and Auto Reopened, the actions that mean an open vulnerability.
* **Severities**: Critical, High, Medium or Low. Leave it empty for all.
* **Dependency Scope**: Runtime for shipped dependencies, Development for devDependencies.

The webhook delivers the alerts of every repository of the organization, private ones included. So when a flow starts, the connector checks with the trigger account's token that this account can read those alerts on GitHub itself:

* With **Repository** set, the account has to be able to read that repository's Dependabot alerts.
* Without it, the account has to be able to read the organization-wide alerts. Only organization owners and security managers can, so a plain member has to set **Repository**.

If the check fails, the flow doesn't start and the error names the repository or organization. The token is not stored with the subscription. The account needs the `repo` scope. Flow Test Mode reads the newest alert of the chosen repository, so it needs **Repository** set.

If a flow receives nothing, check the webhook's **Recent Deliveries**: a `401` response means the secret in GitHub differs from the connector's `webhookSecret`; a `404` means the URL points at an instance (or a hub) where the connector is not installed. If deliveries succeed but a Dependabot flow still gets nothing, make sure the webhook has the **Dependabot alerts** event ticked and that the alert's repository, action, severity and scope match the trigger's filters.

## Backoffice configuration

Configuration ID: `appmixer:github` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

* `clientId` — Client ID of the GitHub OAuth app registered above. Not needed when GitHub is authenticated through the Appmixer Auth Hub.
* `clientSecret` — Client secret of the same OAuth app. Not needed with the Auth Hub.
* `webhookSecret` — The secret of the organization webhook that feeds **On Project Item Changed** and **On Dependabot Alert** (any long random string, the same value as in GitHub). Only needed when one of these triggers is used. On an Auth Hub setup it belongs to the hub's `appmixer:github` configuration, not to the instance.

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:github -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>",
  "webhookSecret": "<webhook secret>"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/github.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
