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:
- To register an app on an organization account, add URL parameters to:
ORGANIZATIONwith the name of the organization where you'd like the customer to register the app.
On the app registration page, the person registering the app can edit the preselected values before submitting the app. If you do not include parameters for required values (like
name) in the URL query string, the person registering the app will need to input a value before they can register the app.
For example, the following URL registers a new public app named
octocat-github-app on a personal account. Using query parameters, the URL preconfigures a description and a callback URL. It also selects read and write permissions for
checks, activates webhooks using the
webhook_active parameter, subscribes to the
check_suite webhook events, and selects the option to request user authorization (OAuth) during installation:
GitHub App configuration parameters
You can use the following query parameters to select a specific configuration for the GitHub App registration. For example, to name the app "octocat-github-app", your query string would include
|The name of the GitHub App. Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub user, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action.|
|A description of the GitHub App.|
|The full URL of your GitHub App's website homepage.|
|A full URL to redirect to after someone authorizes an installation. You can provide up to 10 callback URLs. These URLs are used if your app needs to generate a user access token. For example, |
|If your app authorizes users using the OAuth flow, you can set this option to |
|The full URL to redirect to after someone installs the GitHub App if the app requires additional setup after installation. For more information, see "About the setup URL."|
|Set to |
|Set to |
|Set to |
|The full URL that you would like to send webhook event payloads to.|
|You can specify a secret to secure your webhooks. See "Securing your webhooks" for more details.|
|Webhook events. Some webhook events require |
|This is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the |
GitHub App permissions
You can use query parameters to select the permissions for the GitHub App registration. For more information about the possible permissions you can select for the app, and the endpoints that the app can access with each permission, see "Permissions required for GitHub Apps." For the URL query parameter, use the permission name as the query parameter name, and set the query value to one of the possible values for that permission set.
For example, to select "Read & write" permissions in the user interface for
contents, your query string would include
contents=write. To select "Read-only" permissions in the user interface for
blocking, your query string would include
blocking=read. To select "No access" in the user interface for
checks, your query string would not include the
For more information about permissions and GitHub Apps, see "Choosing permissions for a GitHub App."
GitHub App webhook events
You can use query parameters to enable the GitHub App webhook, designate a webhook URL, and subscribe the app to receive webhook payloads for specific events.
To enable the GitHub App webhook, use
webhook_active=true in your query string. To designate a full URL that you would like to send webhook event payloads to, use
webhook_url in your query string. To subscribe the app to specific webhook payload events, use
events as the query parameter name, and set the query value to the name of the webhook event. For more information about the possible webhook events and the GitHub App permissions required to subscribe to each event, see "Webhook events and payloads."
For example, to subscribe a GitHub App to receive webhook payloads for activity relating to commit comments, the query string would include
&webhook_active=true&webhook_url=https://example.com&events=commit_comment. Note that the
commit_comment webhook event requires the GitHub App to have at least read-level access for the "Contents" repository permission. So your query string should also include a parameter to set the
contents permission to
write. For more information, see "GitHub app permissions."
You cannot use query parameters to set the value of a webhook secret. If an app requires a secret to secure its webhook, the value of the secret must be set in the GitHub UI by the person registering the app.
For more information about webhooks and GitHub Apps, see "Using webhooks with GitHub Apps."