Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

creating-a-github-app.md 6.1 KB

You have to be logged in to leave a comment. Sign In
title intro redirect_from versions
Creating a GitHub App {% data reusables.shortdesc.creating_github_apps %} [/early-access/integrations/creating-an-integration/ /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps/ /apps/building-github-apps/creating-a-github-app] [{free-pro-team *} {enterprise-server *} {github-ae *}]

{% if currentVersion == "free-pro-team@latest" %}To learn how to use GitHub App Manifests, which allow people to create preconfigured GitHub Apps, see "Creating GitHub Apps from a manifest."{% endif %}

{% if currentVersion == "free-pro-team@latest" %} {% note %}

Note: {% data reusables.apps.maximum-github-apps-allowed %}

{% endnote %} {% endif %}

{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} 4. Click New GitHub App. Button to create a new GitHub App 5. In "GitHub App name", type the name of your app. Field for the name of your 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.

  1. Optionally, in "Description", type a description of your app that users will see. Field for a description of your GitHub App
  2. In "Homepage URL", type the full URL to your app's website. Field for the homepage URL of your GitHub App {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
  3. In "Callback URL", type the full URL to redirect to after a user authorizes the installation. This URL is used if your app needs to identify and authorize user-to-server requests.

You can use Add callback URL to provide additional callback URLs, up to a maximum of 10.

Button for 'Add callback URL' and field for callback URL {% else %} 8. In "User authorization callback URL", type the full URL to redirect to after a user authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests. Field for the user authorization callback URL of your GitHub App

{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} 9. By default, to improve your app's security, your app will use expiring user authorization tokens. To opt-out of using expiring user tokens, you must deselect "Expire user authorization tokens". To learn more about setting up a refresh token flow and the benefits of expiring user tokens, see "Refreshing user-to-server access tokens." Option to opt-in to expiring user tokens during GitHub Apps setup {% endif %} 9. If your app authorizes users using the OAuth flow, you can select Request user authorization (OAuth) during installation to allow people to authorize the app when they install it, saving a step. If you select this option, the "Setup URL" becomes unavailable and users will be redirected to your "User authorization callback URL" after installing the app. See "Authorizing users during installation" for more information. Request user authorization during installation 10. If additional setup is required after installation, add a "Setup URL" to redirect users to after they install your app. Field for the setup URL of your GitHub App

{% note %}

Note: When you select Request user authorization (OAuth) during installation in the previous step, this field becomes unavailable and people will be redirected to the "User authorization callback URL" after installing the app.

{% endnote %}

  1. In "Webhook URL", type the URL that events will POST to. Each app receives its own webhook which will notify you every time the app is installed or modified, as well as any other events the app subscribes to. Field for the webhook URL of your GitHub App

  2. Optionally, in "Webhook Secret", type an optional secret token used to secure your webhooks. Field to add a secret token for your webhook

{% note %}

Note: We highly recommend that you set a secret token. For more information, see "Securing your webhooks."

{% endnote %}

  1. In "Permissions", choose the permissions your app will request. For each type of permission, use the drop-down menu and click Read-only, Read & write, or No access. Various permissions for your GitHub App
  2. In "Subscribe to events", choose whether to subscribe your app to Label, Public, Repository, or Watch events. Subscribe to events options for your GitHub App
  3. To choose where the app can be installed, select either Only on this account or Any account. For more information on installation options, see "Making a GitHub App public or private." Installation options for your GitHub App
  4. Click Create GitHub App. Button to create your GitHub App
Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...