About aplicativo GitHub URL parameters
You can add query parameters to these URLs to preselect the configuration of a aplicativo GitHub on a personal or organization account:
- User account:
http(s)://[hostname]/settings/apps/new - Organization account:
http(s)://[hostname]/:org/settings/apps/new
The person creating the app can edit the preselected values from the aplicativo 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:
http(s)://[hostname]/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.
aplicativo GitHub configuration parameters
| Name | Type | Description |
|---|---|---|
name | string | The name of the aplicativo 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. |
description | string | A description of the aplicativo GitHub. |
url | string | The full URL of your aplicativo GitHub's website homepage. |
callback_url | string | The 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_install | boolean | If 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_url | string | The full URL to redirect to after someone installs the aplicativo GitHub if the app requires additional setup after installation. |
setup_on_update | boolean | Set to true to redirect people to the setup URL when installations have been updated, for example, after repositories are added or removed. |
public | boolean | Set to true when your aplicativo GitHub is available to the public or false when it is only accessible to the owner of the app. |
webhook_url | string | The full URL that you would like to send webhook event payloads to. |
webhook_secret | string | You can specify a secret to secure your webhooks. See "Securing your webhooks" for more details. |
events | array of strings | Webhook events. Some webhook events require read or write permissions for a resource before you can select the event when registering a new aplicativo GitHub. See the "aplicativo 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. |
domain | string | The URL of a content reference. |
single_file_name | string | This 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 aplicativo GitHub will manage. |
aplicativo 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.
| Permission | Description |
|---|---|
administration | Grants access to various endpoints for organization and repository administration. Can be one of: none, read, or write. |
checks | Grants access to the Checks API. Can be one of: none, read, or write. |
content_references | Grants access to the "Create a content attachment" endpoint. Can be one of: none, read, or write. |
contents | Grants access to various endpoints that allow you to modify repository contents. Can be one of: none, read, or write. |
deployments | Grants access to the Deployments API. Can be one of: none, read, or write. |
emails | Grants access to the Emails API. Can be one of: none, read, or write. |
followers | Grants access to the Followers API. Can be one of: none, read, or write. |
gpg_keys | Grants access to the GPG Keys API. Can be one of: none, read, or write. |
issues | Grants access to the Issues API. Can be one of: none, read, or write. |
keys | Grants access to the Public Keys API. Can be one of: none, read, or write. |
members | Grants access to manage an organization's members. Can be one of: none, read, or write. |
organization_hooks | Grants access to the Organization Webhooks API. Can be one of: none, read, or write. |
organization_plan | Grants access to get information about an organization's plan using the "Get an organization" endpoint. Can be one of: none or read. |
organization_projects | Grants access to the Projects API. Can be one of: none, read, write, or admin. |
pages | Grants access to the Pages API. Can be one of: none, read, or write. |
plan | Grants access to get information about a user's GitHub plan using the "Get a user" endpoint. Can be one of: none or read. |
pull_requests | Grants access to various pull request endpoints. Can be one of: none, read, or write. |
repository_hooks | Grants access to the Repository Webhooks API. Can be one of: none, read, or write. |
repository_projects | Grants access to the Projects API. Can be one of: none, read, write, or admin. |
single_file | Grants access to the Contents API. Can be one of: none, read, or write. |
starring | Grants access to the Starring API. Can be one of: none, read, or write. |
statuses | Grants access to the Statuses API. Can be one of: none, read, or write. |
team_discussions | Grants access to the Team Discussions API and the Team Discussion Comments API. Can be one of: none, read, or write. |
vulnerability_alerts | Grants 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. |
watching | Grants access to list and change repositories a user is subscribed to. Can be one of: none, read, or write. |
aplicativo GitHub webhook events
| Webhook event name | Required permission | Description |
|---|---|---|
check_run | checks | Verifique se a atividade de execução ocorreu. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "execuções de verificação". |
check_suite | checks | Ocorreu uma atividade de conjuntos de verificações. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de"conjunto de verificações". |
commit_comment | contents | Um comentário de commit foi criado. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "comentário de commit". |
content_reference | content_references | Uma nova referência de conteúdo foi criada. Uma nova referência de conteúdo é criada quando o texto ou comentário de um problema ou pull request inclui uma URL que corresponde a um domínio de referência de conteúdo configurado. Para obter mais informações, consulte "Usar anexos de conteúdo" para saber mais sobre referências de conteúdo e anexos. |
create | contents | Um branch ou tag do Git é criado. Para obter mais informações, consulte a API REST de "dados do Git. |
delete | contents | Um branch ou tag do Git é excluído. Para obter mais informações, consulte a API REST de "dados do Git. |
deployment | deployments | Uma implantação foi criada. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST "implantação". |
deployment_status | deployments | Uma implantação foi criada. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST do "status de implantação". |
fork | contents | Um usuário bifurca um repositório. Para obter mais informações, consulte a API REST de bifurcações". |
gollum | contents | Uma página wiki foi criada ou atualizada. Para obter mais informações, consulte "Sobre wikis". |
issues | issues | Atividade relacionada a um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST de problemas". |
issue_comment | issues | Atividade relacionada a um comentário de um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "comentários de problema". |
label | metadata | Atividade relacionada a um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte API REST de etiquetas". |
member | members | Atividade relacionada aos colaboradores do repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST dos colaboradores". |
membership | members | Atividade relacionada à associação na equipe. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos integrantes da equipe". |
milestone | pull_request | Atividade relacionada aos marcos. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos marcos". |
organization | members | Atividade relacionada a uma organização e seus integrantes. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APRI REST de "organizações". |
page_build | pages | Representa uma tentativa de criação de um site do GitHub Pages, independentemente de êxito. Um push para um branch habilitado de GitHub Pages (gh-pages para páginas de projeto, o branch-padrão para páginas de usuário e organização) aciona este evento. |
project | repository_projects or organization_projects | Atividade relacionada aos quadros de projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte A API REST dos "projetos". |
project_card | repository_projects or organization_projects | Atividade relacionada aos cartões do projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos cartões de projeto". |
project_column | repository_projects or organization_projects | Atividade relacionada a colunas em um quadro de projeto. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST das "colunas do projeto". |
public | metadata | Quando um repositório privado torna-se público. Sem dúvida: o melhor evento de GitHub Enterprise Server. |
pull_request | pull_requests | Atividade relacionada a pull requests. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "pull requests". |
pull_request_review | pull_request | Atividade relacionada a revisões de pull request. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST "Revisões de pull request". |
pull_request_review_comment | pull_request | Atividade relacionada aos comentários de revisão do pull request no diff unificado do pull request. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dos "comentários de revisão de pull request". |
push | contents | Um ou mais commits são enviados para uma branch ou tag de um repositório. |
release | contents | Atividade relacionada a uma versão. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST das versões". |
repository | metadata | Atividade relacionada a um repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST dosrepositórios". |
status | statuses | Quando o status de um commit do Git é alterado. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "status". |
team | members | Atividade relacionada à equipe de uma organização. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "equipes". |
team_add | members | Quando um repositório é adicionado a uma equipe. |
watch | metadata | Quando alguém marca um repositório com uma estrela. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "marcar com uma estrela". |