Registering a GitHub App using URL parameters

You can use URL query parameters to help other people quickly set up a new GitHub App with a specific configuration you have preselected.

In this article

About URL parameters for registering GitHub Apps

You can use URL parameters to preselect the configuration settings of a new GitHub App registration and share a custom link with other people. The link will take people to a GitHub App registration page, where the app settings will be pre-filled according to the URL parameters you included in the URL.

This approach is useful for integrators who want customers to set up an app on their personal account or organization with certain specifications, or for customers using GitHub Enterprise Server who aren't able to install apps from the GitHub Marketplace.

Alternatively, you can create a GitHub App manifest. For more information, see Registering a GitHub App from a manifest.

Creating a custom configuration URL with query parameters

To create a custom configuration URL for a GitHub App on a personal or organization account, add query parameters after the following base URLs.

  • To register an app on a personal account, add URL parameters to: http(s)://HOSTNAME/settings/apps/new
  • To register an app on an organization account, add URL parameters to: http(s)://HOSTNAME/organizations/ORGANIZATION/settings/apps/new. Replace ORGANIZATION with the name of the organization where you'd like the customer to register the app.
  • To register an app on an enterprise account, add URL parameters to: