Skip to content

GitHub / GitHub Enterprise Server

A GitHub App connection to github.com or a self-hosted GHES instance.

This provider fills the scm slot. Configure it in Settings → Integrations, or during first-run setup.

Key Field Type Required Notes
host GitHub host text No GHES hostname, e.g. github.yourco.com. Blank = github.com. Derives api/web/uploads/graphql.
appId GitHub App ID text Yes —
privateKey App private key secret or reference Yes Paste the PEM private key (encrypted at rest), or use env:NAME / file:/path.
webhookSecret Webhook secret secret or reference No HMAC secret for this instance’s inbound webhooks.
clientId OAuth client ID text No —
clientSecret OAuth client secret secret or reference No —

Select Test connection to run a live test against the credentials you supplied. Saving validates and stores the configuration. Every check below is evaluated against the real service, not inferred from the configuration.

Check Outcome
Authenticate as the GitHub App (App-JWT accepted) Must pass
Resolve the App identity (GET /app) Must pass

Adapter id: github-scm.