Building GitHub Apps

Creating a GitHub App

You can create and register a GitHub App under your personal account or under any organization you have administrative access to.

Setting permissions for GitHub Apps

When you create a GitHub App, you set the permissions that define the resources the app can access via the REST API.

Managing allowed IP addresses for a GitHub App

You can add an IP allow list to your GitHub App to prevent your app from being blocked by an organization's own allow list.

Authenticating with GitHub Apps

You can authenticate as a GitHub App or as an installation.

Identifying and authorizing users for GitHub Apps

Your GitHub App can perform actions on behalf of a user, like creating an issue, creating a deployment, and using other supported endpoints.

Rate limits for GitHub Apps

Rate limits for GitHub Apps help control the rate of traffic.

Refreshing user-to-server access tokens

To enforce regular token rotation and reduce the impact of a compromised token, you can configure your GitHub App to use expiring user access tokens.

Creating a GitHub App from a manifest

A GitHub App Manifest is a preconfigured GitHub App you can share with anyone who wants to use your app in their personal repositories. The manifest flow allows someone to quickly create, install, and start extending a GitHub App without needing to register the app or connect the registration to the hosted app code.

Creating a GitHub App using URL parameters

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.