Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Creating a GitHub App using URL parameters

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

Neste artigo

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Ou, learn how to contribute.

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: 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 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:

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.

aplicativo GitHub configuration parameters

NameTypeDescription
namestringThe 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.
descriptionstringA description of the aplicativo GitHub.
urlstringThe full URL of your aplicativo 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 aplicativo 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 aplicativo 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 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.
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 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.

PermissionDescription
administrationGrants access to various endpoints for organization and repository administration. Can be one of: none, read, or write.
blockingGrants access to the Blocking Users API. 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.
metadataGrants access to read-only endpoints that do not leak sensitive data. Can be read or none. Defaults to read when you set any permission, or defaults to none when you don't specify any permissions for the aplicativo GitHub.
organization_administrationGrants access to "Update an organization" endpoint and the Organization Interaction Restrictions API. 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.
organization_user_blockingGrants access to the Blocking Organization Users API. Can be one of: none, read, or write.
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.

aplicativo GitHub webhook events

Webhook event nameRequired permissionDescription
check_runchecksVerifique 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_suitechecksOcorreu 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_commentcontentsUm 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_referencecontent_referencesUma 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.
createcontentsUm branch ou tag do Git é criado. Para obter mais informações, consulte a API REST de "dados do Git.
deletecontentsUm branch ou tag do Git é excluído. Para obter mais informações, consulte a API REST de "dados do Git.
deploymentdeploymentsUma 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_statusdeploymentsUma 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".
forkcontentsUm usuário bifurca um repositório. Para obter mais informações, consulte a API REST de bifurcações".
gollumcontentsUma página wiki foi criada ou atualizada. Para obter mais informações, consulte "Sobre wikis".
issuesissuesAtividade 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_commentissuesAtividade 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".
labelmetadataAtividade 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".
membermembersAtividade 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".
membershipmembersAtividade 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".
milestonepull_requestAtividade 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".
org_blockorganization_administrationAtividade relacionada a pessoas que estão sendo bloqueadas em uma organização. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte oBloqueando usuários da organização" da API REST.
organizationmembersAtividade 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_buildpagesRepresenta 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.
projectrepository_projects or organization_projectsAtividade 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_cardrepository_projects or organization_projectsAtividade 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_columnrepository_projects or organization_projectsAtividade 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".
publicmetadataQuando um repositório privado torna-se público. Sem dúvida: o melhor evento de GitHub.
pull_requestpull_requestsAtividade 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_reviewpull_requestAtividade 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_commentpull_requestAtividade 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".
pushcontentsUm ou mais commits são enviados para uma branch ou tag de um repositório.
releasecontentsAtividade 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".
repositorymetadataAtividade 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".
repository_dispatchcontentsAllows integrators using GitHub Actions to trigger custom events.
statusstatusesQuando 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".
teammembersAtividade 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_addmembersQuando um repositório é adicionado a uma equipe.
watchmetadataQuando 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".

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Ou, learn how to contribute.