Get started

Account and profile

Authentication

Repositories

Enterprise administrators

Billing and payments

Site policy

Organizations

Code security

Pull requests

GitHub Issues

GitHub Actions

GitHub Copilot

GitHub Codespaces

Migrations

GitHub Packages

Search on GitHub

Apps

Webhooks and events

REST API

GraphQL API

GitHub CLI

GitHub Discussions

GitHub Sponsors

Building communities

GitHub Pages

Education

GitHub Desktop

GitHub Support

Electron

CodeQL

Enterprise Cloud

Enterprise Server

Enterprise Server 3.4

Enterprise Server 3.5

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Free, Pro, & Team

GitHub AE

Overview

GitHub Apps overview

About using apps

About using GitHub Apps

Install from third party

Installing a GitHub App from a third party

Authorizing GitHub Apps

Authorized integrations

Reviewing and revoking authorization of GitHub Apps

Approve new permissions

Approving updated permissions for a GitHub App

Review and modify

Reviewing and modifying installed GitHub Apps

Using GitHub Apps

About creating apps

About creating GitHub Apps

Rate limits

Rate limits for GitHub Apps

Creating a GitHub App

Permissions

Choosing permissions for a GitHub App

Using webhooks

Using webhooks with GitHub Apps

Manage app visibility

Making a GitHub App public or private

Share with GHES

Making your GitHub App available for GitHub Enterprise Server

App creation manifest flow

Creating a GitHub App from a manifest

App creation query parameters

Creating a GitHub App using URL parameters

Custom badges

Creating a custom badge for your GitHub App

Callback URL

About the user authorization callback URL

Setup URL

About the setup URL

Best practices

Best practices for creating a GitHub App

Setting up a GitHub App

Authentication overview

About authentication with a GitHub App

Authenticate as an app

Authenticating as a GitHub App

Authenticate as an installation

Authenticating as a GitHub App installation

Authenticate on behalf of users

Authenticating with a GitHub App on behalf of a user

Manage private keys

Managing private keys for GitHub Apps

Generate a JWT

Generating a JSON Web Token (JWT) for a GitHub App

Generate an installation access token

Generating an installation access token for a GitHub App

Generate a user access token

Generating a user access token for a GitHub App

Refresh user access tokens

Refreshing user access tokens

Authenticating with a GitHub App

Quickstart

Quickstart for building GitHub Apps

Development environment

Setting up your development environment to create a GitHub App

Respond to webhooks

Building a GitHub App that responds to webhook events

Build a "Login" button

Building a "Login with GitHub" button with a GitHub App

Build a CLI

Building a CLI with a GitHub App

Build an app with the REST API

Using the GitHub API in your app

Use with Actions

Making authenticated API requests with a GitHub App in a GitHub Actions workflow

CI tests using Checks API

Creating CI tests with the Checks API

Migrate from OAuth Apps

Migrating OAuth Apps to GitHub Apps

Guides

Creating GitHub Apps

GitHub App managers

About GitHub App managers

Modifying a GitHub App

Install your app

Installing your own GitHub App

Share your app

Sharing your GitHub App

Activate optional features

Activating optional features for GitHub Apps

Suspend app installation

Suspending a GitHub App installation

Transfer ownership

Transferring ownership of a GitHub App

Deleting a GitHub App

Maintaining GitHub Apps

Authorizing OAuth Apps

Review OAuth apps

Reviewing your authorized OAuth applications

Third-party applications

Connecting with third-party applications

Using OAuth Apps

GitHub Apps & OAuth Apps

Differences between GitHub Apps and OAuth Apps

Rate limits for OAuth Apps

Creating an OAuth App

Authenticating with OAuth App

Authenticating to the REST API with an OAuth App

Scopes for OAuth Apps

Create custom badges

Creating a custom badge for your OAuth App

Building OAuth Apps

Modifying an OAuth App

Activating optional features for OAuth Apps

Transferring ownership of an OAuth App

Troubleshoot authorization

Troubleshooting authorization request errors

Troubleshoot token request

Troubleshooting OAuth App access token request errors

Deleting an OAuth App

Maintaining OAuth Apps

OAuth Apps

GitHub Apps documentation

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.