Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
GitHub AE is currently under limited release.

Creating a GitHub App using URL parameters

You can preselect the settings of a new GitHub App using URL query parameters to quickly set up the new GitHub App's configuration.

About GitHub App URL parameters

You can add query parameters to these URLs to preselect the configuration of a GitHub App on a personal or organization account:

  • Personal account: http(s)://HOSTNAME/settings/apps/new
  • Organization account: http(s)://HOSTNAME/organizations/:org/settings/apps/new

The person creating the app can edit the preselected values from the GitHub App registration page, before submitting the app. If you do not include required parameters in the URL query string, like name, the person creating the app will need to input a value before submitting the app.

For apps that require a secret to secure their webhook, the secret's value must be set in the form by the person creating the app, not by using query parameters. For more information, see "Webhook のセキュリティ保護."

The following URL creates a new public app called octocat-github-app with a preconfigured description and callback URL. This URL also selects read and write permissions for checks, subscribes to the check_run and check_suite webhook events, and selects the option to request user authorization (OAuth) during installation:


The complete list of available query parameters, permissions, and events is listed in the sections below.

GitHub App configuration parameters

namestringThe 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.
descriptionstringA description of the GitHub App.
urlstringThe full URL of your GitHub App's website homepage.
callback_urlsarray of stringsA 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, callback_urls[]=[]= For more information, see "GitHub App を作成すると、コールバック URL を指定できます。."
request_oauth_on_installbooleanIf your app authorizes users using the OAuth flow, you can set this option to true 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 callback_url after installing the app.
setup_urlstringThe full URL to redirect to after someone installs the GitHub App if the app requires additional setup after installation.
setup_on_updatebooleanSet to true to redirect people to the setup URL when installations have been updated, for example, after repositories are added or removed.
publicbooleanSet to true when your GitHub App is available to the public or false when it is only accessible to the owner of the app.
webhook_activebooleanSet to false to disable webhook. Webhook is enabled by default.
webhook_urlstringThe full URL that you would like to send webhook event payloads to.
webhook_secretstringYou can specify a secret to secure your webhooks. See "Webhook のセキュリティ保護" for more details.
eventsarray of stringsWebhook events. Some webhook events require read or write permissions for a resource before you can select the event when registering a new GitHub App. See the "GitHub App webhook events" section for available events and their required permissions. You can select multiple events in a query string. For example, events[]=public&events[]=label.
single_file_namestringThis is a narrowly-scoped permission that allows the app to access a single file in any repository. When you set the single_file permission to read or write, this field provides the path to the single file your GitHub App will manage.

GitHub App permissions

You can select permissions in a query string using the permission name in the following table as the query parameter name and the permission type as the query value. 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 checks permission.

administrationGrants access to various endpoints for organization and repository administration. Can be one of: none, read, or write.
checksGrants access to the Checks API. Can be one of: none, read, or write.
contentsGrants access to various endpoints that allow you to modify repository contents. Can be one of: none, read, or write.
deploymentsGrants access to the Deployments API. Can be one of: none, read, or write.
followersGrants access to the Followers API. Can be one of: none, read, or write.
gpg_keysGrants access to the GPG Keys API. Can be one of: none, read, or write.
issuesGrants access to the Issues API. Can be one of: none, read, or write.
keysGrants access to the Public Keys API. Can be one of: none, read, or write.
membersGrants access to manage an organization's members. Can be one of: none, read, or write.
organization_hooksGrants access to the Organization Webhooks API. Can be one of: none, read, or write.
organization_planGrants access to get information about an organization's plan using the "Organizations" endpoint. Can be one of: none or read.
organization_projectsGrants access to the Projects API. Can be one of: none, read, write, or admin.
pagesGrants access to the Pages API. Can be one of: none, read, or write.
planGrants access to get information about a user's GitHub plan using the "ユーザー" endpoint. Can be one of: none or read.
pull_requestsGrants access to various pull request endpoints. Can be one of: none, read, or write.
repository_hooksGrants access to the Repository Webhooks API. Can be one of: none, read, or write.
repository_projectsGrants access to the Projects API. Can be one of: none, read, write, or admin.
single_fileGrants access to the Contents API. Can be one of: none, read, or write.
starringGrants access to the Starring API. Can be one of: none, read, or write.
statusesGrants access to the Statuses API. Can be one of: none, read, or write.
team_discussionsGrants access to the Team Discussions API and the Team Discussion Comments API. Can be one of: none, read, or write.
vulnerability_alertsGrants access to receive Dependabot alerts in a repository. See "Dependabot アラートについて" to learn more. Can be one of: none, read, or write.
watchingGrants access to list and change repositories a user is subscribed to. Can be one of: none, read, or write.

GitHub App webhook events

Webhook event nameRequired permissionDescription
check_runchecksチェックランのアクティビティが発生しました。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"チェック ラン" REST API を参照してください。
check_suitechecksチェックスイートのアクティビティが発生しました。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。詳細については、「チェック スイート」 REST API を参照してください。
commit_commentcontentsコミットコメントが作成されました。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、「コミットのコメント」 REST API を参照してください。
createcontentsGitブランチもしくはタグが作成されました。 詳しくは、REST API 「Git database」をご覧ください。
deletecontentsGitブランチまたはタグが削除されました。 詳しくは、REST API 「Git database」をご覧ください。
deploymentdeploymentsデプロイメントが作成されました。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。詳細については、"deployment" の REST API を参照してください。
deployment_statusdeploymentsデプロイメントが作成されました。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"deployments" の REST API を参照してください。
forkcontentsユーザがリポジトリをフォークします。 詳しくは、REST API 「リポジトリ」をご覧ください。
gollumcontentswikiページが作成もしくは更新されました。 詳しくは、「ウィキについて」を参照してください。
issuesissuesIssueに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、REST API の「Issue」を参照してください。
issue_commentissuesIssueあるいはPull Requestコメントに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。詳細については、「issue comments」の REST API を参照してください。
labelmetadataラベルに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"labels" の REST API を参照してください。
membermembersリポジトリのコラボレータに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"collaborators" の REST API を参照してください。
membershipmembersTeamのメンバーシップに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"team members" の REST API を参照してください。
milestonepull_requestマイルストーンに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"milestones" の REST API を参照してください。
organizationmembersOrganization及びそのメンバーと関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"organizations" の REST API を参照してください。
page_buildpages成功か否かにかかわらず、GitHub Pagesサイトの試行されたビルドを表します。 このイベントは、GitHub Pages が有効化されたブランチ (プロジェクトのページなら gh-pages、ユーザーおよび組織のページなら既定のブランチ) へのプッシュでトリガーされます。
projectrepository_projects or organization_projectsプロジェクト ボード に関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、「プロジェクト」 REST API を参照してください。
project_cardrepository_projects or organization_projectsプロジェクト ボード のカードに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"project cards" の REST API を参照してください。
project_columnrepository_projects or organization_projectsプロジェクト ボード の列に関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、「プロジェクト列」 REST API を参照してください。
publicmetadataプライベートリポジトリがパブリックにされたとき。 間違いなく: 最高のGitHub AEイベント。
pull_requestpull_requestsPull Requestに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、「pull request」 REST API を参照してください。
pull_request_reviewpull_requestPull Requestレビューに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。詳細については、「pull request のレビュー」の REST API を参照してください。
pull_request_review_commentpull_requestPull Requestの統合diff中のPull Requestレビューコメントに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。詳細については、「プルリクエストのレビュー コメント」の REST API を参照してください。
pull_request_review_threadpull_request解決済みまたは未解決とマークされている pull request のコメント スレッドに関連するアクティビティ アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。
releasecontentsリリースに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"リリース" REST API を参照してください。
repositorymetadataリポジトリに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、「リポジトリ」 REST API を参照してください。
statusstatusesGitコミットのステータスが変化したとき。 詳しくは、REST API 「コミット」をご覧ください。
teammembersOrganizationのTeamに関連するアクティビティ。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。 詳細については、"teams" の REST API を参照してください。
watchmetadata誰かがリポジトリにStarを付けたとき。 アクティビティの種類は、ペイロード オブジェクトの action プロパティで指定されます。詳細については、REST API の「starring」を参照してください。