我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

Creating a GitHub App using URL parameters

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

本文内容

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。

About GitHub 应用程序 URL parameters

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

  • User account: https://github.com/settings/apps/new
  • Organization account: https://github.com/organizations/:org/settings/apps/new

The person creating the app can edit the preselected values from the GitHub 应用程序 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.

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:

https://github.com/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_url=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite

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

GitHub 应用程序 configuration parameters

NameTypeDescription
namestringThe name of the GitHub 应用程序. 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 应用程序.
urlstringThe full URL of your GitHub 应用程序's website homepage.
callback_urlstringThe full URL to redirect to after someone authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.
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 应用程序 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 应用程序 is available to the public or false when it is only accessible to the owner of the app.
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 "Securing your webhooks" 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 应用程序. See the "GitHub 应用程序 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.
domainstringThe URL of a content reference.
single_file_namestringWhen you grant read or write access to the single_file permission, this field provides the path to the single file your GitHub 应用程序 will manage.

GitHub 应用程序 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.

PermissionDescription
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.
content_referencesGrants access to the "Create a content attachment" endpoint. 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.
emailsGrants access to the Emails 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 "Get an organization" 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 "Get a user" 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 security alerts for vulnerable dependencies in a repository. See "About security alerts for vulnerable dependencies" to learn more. Can be one of: none or read.
watchingGrants access to list and change repositories a user is subscribed to. Can be one of: none, read, or write.

GitHub 应用程序 webhook events

Webhook event nameRequired permissionDescription
check_runchecks检查运行活动已发生。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "check runs" REST API.
check_suitechecks检查套件活动已发生。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "check suites" REST API.
commit_commentcontents提交评论已创建。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "commit comment" REST API.
content_referencecontent_references新的内容引用为 created。 当议题或拉取请求的正文或注释包含与配置的内容引用域匹配的 URL 时,将创建新的内容引用。 有关内容引用和附件的更多信息,请参阅“使用内容附件”。
createcontentsGit 分支或标签已创建。 更多信息请参阅“Git 数据”REST API。
deletecontentsGit 分支或标签已删除。 更多信息请参阅“Git 数据”REST API。
deploymentdeployments已创建部署。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "deployment" REST API.
deployment_statusdeployments已创建部署。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "deployment statuses" REST API.
forkcontents用户复刻仓库。 更多信息请参阅“复刻”REST API。
gollumcontents创建或更新 wiki 页面。 更多信息请参阅“关于 wikis”。
issuesissues与议题相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "issues" REST API.
issue_commentissues与议题评论相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "issue comments" REST API.
labelmetadata与议题相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "labels" REST API.
membermembers与仓库协作者相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "collaborators" REST API.
membershipmembers与团队成员相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "team members" REST API.
milestonepull_request与里程碑相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "milestones" REST API.
organizationmembers与组织及其成员相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "organizations" REST API.
page_buildpagesRepresents an attempted build of a GitHub Pages site, whether successful or not. A push to a GitHub Pages enabled branch (gh-pages for project pages, the default branch for user and organization pages) triggers this event.
projectrepository_projects or organization_projects与项目板有关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "projects" REST API.
project_cardrepository_projects or organization_projects与项目卡有关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "project cards" REST API.
project_columnrepository_projects or organization_projects与项目板中的列相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "project columns" REST API.
publicmetadata当私有仓库公开时。 Without a doubt: the best GitHub Enterprise event.
pull_requestpull_requests与拉取请求相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "pull requests" REST API.
pull_request_reviewpull_request与拉取请求审查相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "pull request reviews" REST API.
pull_request_review_commentpull_request与拉取请求统一差异中的拉取请求审查评论相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "pull request review comments" REST API.
pushcontents一个或多个提交被推送到仓库分支或标记。
releasecontents与发行版相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "releases" REST API.
repositorymetadata与仓库相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "repositories" REST API.
statusstatuses当 Git 提交的状态发生更改时。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "statuses" REST API.
teammembers与组织的团队相关的活动。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "teams" REST API.
team_addmembers仓库被添加到团队时。
watchmetadata当有人标星仓库时。 活动类型在有效负载对象的 action 属性中指定。 For more information, see the "starring" REST API.

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。