Skip to main content

This version of GitHub Enterprise Server was discontinued on 2024-01-04. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.

Registering a GitHub App

Learn about building GitHub Apps.

Registering a GitHub App

You can register a GitHub App under your personal account or under any organization you own.

About the user authorization callback URL

You can specify a URL that users will be redirected to after they authorize a GitHub App.

About the setup URL

You can specify a URL that users will be redirected to after they install a GitHub App.

Choosing permissions for a GitHub App

The permissions of a GitHub App determine what the app can do with GitHub's APIs and what webhooks the app can receive.

Using webhooks with GitHub Apps

Your GitHub App can subscribe to webhook events to receive notifications whenever certain activity occurs.

Making a GitHub App public or private

When registering a GitHub App, you can make it public so that other GitHub users or organizations can install the app, or private so that you can only install it on the account that owns the app.

Rate limits for GitHub Apps

Rate limits restrict the rate of traffic to your GitHub Enterprise Server instance, to help ensure consistent access for all users.

Creating a custom badge for your GitHub App

You can replace the default badge on your GitHub App by uploading your own logo image and customizing the background.