Skip to main content
GitHub Docs
Version:
Free, Pro, & Team
Search or ask Copilot
Search or ask
Copilot
Select language: current language is English
Search or ask Copilot
Search or ask
Copilot
Open menu
Collapse sidebar
Expand sidebar
Scroll breadcrumbs left
Home
Apps
Creating GitHub Apps
Writing code for a GitHub App
Build CI checks
Scroll breadcrumbs right
Apps
Overview
Using GitHub Apps
About using apps
Install from Marketplace for user
Install from Marketplace for org
Install from third party
Install your own app
Request for org
Authorize
Approve new permissions
Review your authorizations
Review installations
Privileged apps
Creating GitHub Apps
About creating GitHub Apps
About creating apps
GitHub App versus other options
Best practices
Migrate from OAuth apps
Registering a GitHub App
Register a GitHub App
Callback URLs
Setup URL
Permissions
Webhooks
Visibility
Rate limits
Custom badge
Authenticate with a GitHub App
About authentication
Authenticate as an app
Authenticate as an installation
Authenticate on behalf of users
Manage private keys
Generate a JWT
Generate an installation access token
Generate a user access token
Refresh user access tokens
Authenticate in Actions workflow
Writing code for a GitHub App
About writing GitHub App code
Quickstart
Respond to webhooks
Build a "Login" button
Build a CLI
Build CI checks
Sharing GitHub Apps
Share your app
Share with GHES
App manifest
App query parameters
Maintaining GitHub Apps
Modify app settings
Activate optional features
GitHub App managers
Manage allowed IP addresses
Suspend an installation
Transfer ownership
Delete your app
GitHub Marketplace
Overview
About GitHub Marketplace for apps
About marketplace badges
Publisher verification
Create Marketplace apps
Listing requirements
Security best practice
Customer experience best practice
View listing metrics
View listing transactions
Marketplace API usage
REST API
Webhook events
Testing your app
New purchases & free trials
Handling plan changes
Plan cancellations
List an app on the Marketplace
Draft an app listing
Write listing descriptions
Set listing pricing plans
Webhooks for plan changes
Submit your listing
Delete your listing
Sell apps on the Marketplace
Pricing plans for apps
Billing customers
Receive payment
OAuth apps
Using OAuth apps
Install app personal account
Install app organization
Authorizing OAuth apps
Review OAuth apps
Third-party applications
Privileged apps
Building OAuth apps
GitHub Apps & OAuth apps
Rate limits
Creating an OAuth app
Authenticate with an OAuth app
Authorizing OAuth apps
Scopes for OAuth apps
Create custom badges
Best practices
Maintaining OAuth apps
Modifying an OAuth app
Activate optional features
Transfer ownership
Troubleshoot authorization
Troubleshoot token request
Deleting an OAuth app
OAuth 2.0 and OIDC Discovery documents
Building CI checks with a GitHub App
Build a continuous integration server to run tests using a GitHub App and checks.
Copy as Markdown
In this article
Introduction
Prerequisites
Setup