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.

Criar um aplicativo GitHub usando parâmetros de URL

Você pode pré-selecionar as configurações de um novo aplicativo GitHub usando URL parâmetros de consulta para definir rapidamente a configuração do novo aplicativo GitHub.

Neste artigo

Sobre parâmetros de URL do aplicativo GitHub.

Você pode adicionar parâmetros de consulta a essas URLs para pré-selecionar a configuração de um aplicativo GitHub em uma conta pessoal ou de organização:

  • Conta de usuário: https://github.com/settings/apps/new
  • Conta de organização: https://github.com/:org/settings/apps/new

A pessoa que está criando o aplicativo pode editar os valores pré-selecionados a partir da página de registro do aplicativo GitHub, antes de enviar o aplicativo. Se você não incluir os parâmetros necessários na string de consulta da URL, como, por exemplo, o nome, a pessoa que criar o aplicativo deverá inserir um valor antes de enviar o aplicativo.

A URL a seguir cria um novo aplicativo pública denominado octocat-github-app com uma descrição pré-configurada e URL de chamada de retorno. Esta URL também seleciona permissões de leitura e gravação para verificações, inscreve-se nos eventos webhook de check_run e <code>check_suite e seleciona a opção de solicitar autorização do usuário (OAuth) durante a instalação:

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

Lista completa de parâmetros de consulta, permissões e eventos disponíveis encontra-se nas seções abaixo.

Parâmetros de configuração do aplicativo GitHub

NomeTipoDescrição
namestringO nome do aplicativo GitHub. Dê um nome claro e sucinto ao seu aplicativo. Seu aplicativo não pode ter o mesmo nome de um usuário existente no GitHub, a menos que seja o seu próprio nome de usuário ou da sua organização. Uma versão movida do nome do seu aplicativo será exibida na interface do usuário quando sua integração realizar uma ação.
descriçãostringUma descrição do aplicativo GitHub.
urlstringA URL completa da página inicial do site do seu aplicativo GitHub.
callback_urlstringA URL completa para onde redirecionar após alguém autorizar uma instalação. Esta URL é usada se o aplicativo precisar identificar e autorizar solicitações de usuário para servidor.
request_oauth_on_installbooleanSe seu aplicativo autoriza usuários a usar o fluxo OAuth, você poderá definir essa opção como verdadeiro para permitir que pessoas autorizem o aplicativo ao instalá-lo, economizando um passo. Se você selecionar esta opção, setup_url irá tornar-se indisponível e os usuários serão redirecionados para sua callback_url após instalar o aplicativo.
setup_urlstringA URL completa para redirecionamento após alguém instalar o aplicativo GitHub, se o aplicativo precisar de configuração adicional após a instalação.
setup_on_updatebooleanDefina como verdadeiro para redirecionar as pessoas para a URL de configuração quando as instalações forem atualizadas, por exemplo, após os repositórios serem adicionados ou removidos.
públicobooleanDefina verdadeiro quando seu aplicativo GitHub estiver disponível para o público ou como falso quando só for acessível pelo proprietário do aplicativo.
webhook_urlstringA URL completa para a qual você deseja enviar as cargas do evento de webhook.
webhook_secretstringVocê pode especificar um segredo para proteger seus webhooks. Consulte "Protegendo seus webhooks" para obter mais detalhes.
eventosarray de strignsEventos webhook. Alguns eventos de webhook exigem permissões de leitura ou gravação para um recurso antes de poder selecionar o evento ao registrar um novo aplicativo GitHub, . Consulte a seção "aplicativo GitHub eventos de webhook" para eventos disponíveis e suas permissões necessárias. Você pode selecionar vários eventos em uma string de consulta. Por exemplo, eventos[]=public&eventos[]=label.
domíniostringA URL de uma referência de conteúdo.
single_file_namestringEsta é uma permissão de escopo limitado que permite que o aplicativo acesse um único arquivo em qualquer repositório. Quando você define a permissão single_file para read ou write, este campo fornece o caminho para o único arquivo que o aplicativo GitHub gerenciará. Se você precisar gerenciar vários arquivos, veja single_file_paths abaixo.
single_file_pathsarray de strignsIsso permite que o aplicativo acesse até dez arquivos especificados em um repositório. Quando você define a permissão single_file para read ou write, este array pode armazenar os caminhos de até dez arquivos que seu aplicativo GitHub gerenciará. Todos esses arquivos recebem a mesma permissão definida por single_file, e não têm permissões individuais separadas. Quando dois ou mais arquivos estão configurados, a API retorna multiple_single_files=true, caso contrário retorna multiple_single_files=false.

Permissões do aplicativo GitHub

Você pode selecionar permissões em uma string de consultas usando o nome da permissão na tabela a seguir como o nome do parâmetro de consulta e o tipo de permissão como valor da consulta. Por exemplo, para selecionar permissões de Leitura & gravação na interface de usuário para conteúdo, sua string de consulta incluiria &contents=write. Para selecionar as permissões Somente leitura na interface de usuário para bloquear, sua string de consulta incluiria &blocking=read. Para selecionar sem acesso na interface do usuário para verificações, sua string de consulta não incluiria a permissão verificações.

PermissãoDescrição
administraçãoConcede acesso a vários pontos finais para administração de organização e repositório. Pode ser: nenhum, leituraou gravação.
bloqueioConcede acesso à API de usuários de bloqueio. Pode ser: nenhum, leitura ou gravação.
VerificaçõesConcede acesso à API de verificação. Pode ser: nenhum, leitura ou gravação.
content_referencesConcede acesso ao ponto final "Criar um anexo de conteúdo. Pode ser: nenhum, leitura ou gravação.
ConteúdoConcede acesso a vários pontos finais que permitem modificar o conteúdo do repositório. Pode ser: nenhum, leitura ou gravação.
ImplantaçõesConcede acesso à API de implementação. Pode ser um das: none, read, ou write
emailsConcede acesso à API de e-mails. Pode ser: nenhum, leitura ou gravação.
seguidoresConcede acesso à API de seguidores. Pode ser: nenhum, leitura ou gravação.
gpg_keysConcede acesso à API de chaves de GPG. Pode ser: nenhum, leitura ou gravação.
ProblemasConcede acesso à API de problemas. Pode ser: nenhum, leitura ou gravação.
chavesConcede acesso à API de chaves públicas. Pode ser: nenhum, leitura ou gravação.
membersConcede acesso para gerenciar os membros de uma organização. Pode ser: nenhum, leituraou gravação.
metadadosConcede acesso a pontos finais somente leitura que não vazam dados confidenciais. Pode ser leitura ou nenhum. O padrão é leitura, ao definir qualquer permissão, ou nenhum quando você não especificar nenhuma permissão para o aplicativo GitHub.
organization_administrationConcede acesso ao ponto final "Atualizar uma organização" ponto final e Pa API de restrições de interação da organização. Pode ser: nenhum, leitura ou gravação.
organization_hooksConcede acesso à API de webhooks da organização. Pode ser: nenhum, leitura ou gravação.
organization_planConcede acesso para obter informações sobre o plano de uma organização usando o ponto final "Obter uma organização". Pode ser: nenhum ou leitura.
organization_projectsConcede acesso à API de Projetos. Pode ser: nenhum, leitura, gravação ou admin.
organization_user_blockingConcede acesso à API de usuários de bloqueio da organização. Pode ser: nenhum, leitura ou gravação.
PáginasConcede acesso à API de páginas. Pode ser: nenhum, leitura ou gravação.
planoConcede acesso para obter informações sobre o plano de um usuário do GitHub que usa o ponto final "Obter um usuário". Pode ser: nenhum ou leitura.
pull_requestsConcede acesso a vários pontos finais do pull request. Pode ser: nenhum, leitura ou gravação.
repository_hooksConcede acesso à API de webhooks do repositório. Pode ser: nenhum, leitura ou gravação.
repository_projectsConcede acesso à API de Projetos. Pode ser: nenhum, leutra, gravação ou administrador.
single_fileConcede acesso à API de conteúdo. Pode ser: nenhum, leitura ou gravação.
estrelaConcede acesso à API estrelada. Pode ser: nenhum, leitura ou gravação.
StatusConcede acesso à API de status. Pode ser: nenhum, leitura ou gravação.
team_discussionsConcede acesso à API de discussões de equipe e à API de comentários de discussão de equipe. Pode ser: nenhum, leitura ou gravação.
vulnerability_alertsConcede acesso a alertas de segurança para dependências vulneráveis em um repositório. Consulte "Sobre alertas de segurança para dependências vulneráveis" para saber mais. Pode ser: nenhum ou leitura.
inspecionandoConcede acesso à lista e alterações de repositórios que um usuário assinou. Pode ser: nenhum, leitura ou gravação.

Eventos webhook do aplicativo GitHub

Nome do evento webhookPermissão necessáriaDescrição
check_runVerificaçõesVerifique 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_suiteVerificaçõesOcorreu 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_commentConteúdoUm 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.
createConteúdoUm branch ou tag do Git é criado. Para obter mais informações, consulte a API REST de "dados do Git.
deleteConteúdoUm branch ou tag do Git é excluído. Para obter mais informações, consulte a API REST de "dados do Git.
implantaçãoImplantaçõesUma 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".
implantação_statusImplantaçõesUma 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".
bifurcaçãoConteúdoUm usuário bifurca um repositório. Para obter mais informações, consulte a API REST de bifurcações".
gollumConteúdoUma página wiki foi criada ou atualizada. Para obter mais informações, consulte "Sobre wikis".
ProblemasProblemasAtividade 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_commentProblemasAtividade 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".
etiquetametadadosAtividade 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".
integrantemembersAtividade 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".
filiaçãomembersAtividade 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".
marcopull_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" REST API.
organizaçãomembersAtividade 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_buildPáginasRepresenta 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 ou 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 ou 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 ou 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".
públicometadadosQuando 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".
pushConteúdoUm ou mais commits são enviados para uma branch ou tag de um repositório.
versãoConteúdoAtividade 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".
repositóriometadadosAtividade 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_dispatchConteúdoPermite aos integradores que usam o GitHub Actions acionar eventos personalizados.
statusStatusQuando 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".
equipemembersAtividade 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.
inspecionarmetadadosQuando 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".

Esse documento ajudou você?

Privacy policy

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.