Eventos de webhook e cargas

Ao configurar um webhook, você pode usar a interface do usuário ou API para escolher quais eventos enviarão cargas. Assinar apenas os eventos específicos que pretende gerenciar limita o número de solicitações HTTP para o seu servidor. Você também pode assinar todos os eventos atuais e futuros. Por padrão, os webhooks são apenas inscritos no evento de push. Você pode alterar a lista de eventos assinados a qualquer momento.

Você pode criar webhooks que assinam os eventos listados nesta página. Cada evento de webhook inclui uma descrição das propriedades do webhook e uma carga de exemplo. Para obter mais informações, consulte "Criar webhooks."

Propriedades comuns do objeto da carga do webhook

Cada carga do evento do webhook também contém propriedades únicas para o evento. Você pode encontrar as propriedades únicas nas seções individuais de tipos de evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A maioria das cargas de webhook contém uma ação `` propriedade que contém a atividade específica que acionou o evento.
`remetente`	`objeto`	O usuário que ativou o evento. Esta propriedade está incluída em todas as cargas do webhook.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu. As cargas do webhook contêm a propriedade `repository` quando ocorre o evento a partir da atividade em um repositório.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub. Para obter mais informações, consulte "Criar um aplicativo GitHub.

As propriedades únicas para um evento de webhook são as mesmas propriedades que você encontrará na propriedade payload ao usar a Eventos API. Uma exceção é o evento de push. As propriedades únicas da carga do webhook do evento push e a propriedade carga na API de eventos são diferentes. A carga do webhook contém informações mais detalhadas.

Observação: As cargas são limitados a 25 MB. Se o seu evento gerar uma carga maior, um webhook não será disparado. Isso pode acontecer, por exemplo, em um evento criar, caso muitos branches ou tags sejam carregados de uma só vez. Sugerimos monitorar o tamanho da sua carga para garantir a entrega.

Cabeçalhos de entrega

As cargas de HTTP POST que são entregues no ponto de extremidade da URL configurado do seu webhook conterão vários cabeçalhos especiais:

Header	Descrição
`X-GitHub-Event`	Nome do evento que ativou a entrega.
`X-GitHub-Delivery`	Um GUID para identificar a entrega.
`X-GitHub-Enterprise-Version`	A versão da instância do GitHub Enterprise Server que enviou a carga do HTTP POST.
`X-GitHub-Enterprise-Host`	O nome do host da instância de GitHub Enterprise Server que enviou a carga HTTP POST.
`X-Hub-Signature`	Este cabeçalho é enviado se o webhook for configurado com um `secret`. Este é o resumo hexadecimal de HMAC do texto da solicitação e é gerado usando a função hash SHA-1 e `segredo` como a `chave` de HMAC.

Além disso, o User-Agent para as solicitações terá o prefixo GitHub-Hookshot/.

Exemplo de entrega

> POST /payload HTTP/2

> Host: localhost:4567
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958
> X-GitHub-Enterprise-Version: 2.15.0
> X-GitHub-Enterprise-Host: example.com
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6
> User-Agent: GitHub-Hookshot/044aadd
> Content-Type: application/json
> Content-Length: 6615
> X-GitHub-Event: issues

> {
>   "action": "opened",
>   "issue": {
>     "url": "http(s)://[hostname]/api/v3/repos/octocat/Hello-World/issues/1347",
>     "number": 1347,
>     ...
>   },
>   "repository" : {
>     "id": 1296269,
>     "full_name": "octocat/Hello-World",
>     "owner": {
>       "login": "octocat",
>       "id": 1,
>       ...
>     },
>     ...
>   },
>   "sender": {
>     "login": "octocat",
>     "id": 1,
>     ...
>   }
> }

check_run

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".

Nota: A API Checks procura apenas por pushes no repositório onde o conjunto de verificação ou execução de verificação foram criadas. Pushes para um branch em um repositório bifurcado não foi detectado e retorna um array pull_requests vazio e um valor null para head_branch.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada. Pode ser uma das ações a seguir: `created` - Uma nova execução de verificação foi criada. `completed` - O `status` da execução da verificação está `completed`. `rerequested` - Alguém pediu para executar novamente sua verificação a partir da interface de usuário do pull request. Veja "Sobre verificações de status" para mais informações sobre a interface do usuário do GitHub. Ao receber uma ação `rerequested`, você deverá criar uma nova execução de verificação. Apenas o aplicativo GitHub que alguém solicitar para repetir a verificação receberá a carga `rerequested`. `requested_action` - Alguém solicitou novamente que se tome uma ação fornecida pelo seu aplicativo. Apenas o aplicativo GitHub para o qual alguém solicitou uma ação receberá a carga `requested_action`. Para saber mais sobre verificações executadas e ações solicitadas, consulte "Execuções de verificação e ações solicitadas."
`check_run`	`objeto`	O check_run.
`check_run[status]`	`string`	O status atual da execução da verificação. Pode ser `queued`, `in_progress` ou `completed`.
`check_run[conclusion]`	`string`	O resultado da execução de verificação concluída. Pode ser: `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` ou `stale`. Este valor será `null` até que a execução da verificação seja `completed`.
`check_run[name]`	`string`	O nome da execução da verificação.
`check_run[check_suite][id]`	`inteiro`	A identificação do conjunto de verificações do qual a execução de verificação faz parte.
`check_run[check_suite][pull_requests]`	`array`	Um array de pull requests que correspondem a este conjunto de verificações. Um pull request corresponde a um conjunto de verificações se tiverem os mesmos `head_sha` e `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.
`requested_action`	`objeto`	A ação solicitada pelo usuário.
`requested_action[identifier]`	`string`	A referência de integrador da ação solicitada pelo usuário.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada. Pode ser: `completed` - Todas as verificações executadas em um conjunto de verificações foram concluídas. `requested` - Ocorre quando o novo código é carregado para o repositório do aplicativo. Ao receber os eventos de ação `requested`, você deverá criar uma nova execução de verificação. `rerequested` - Ocorre quando alguém solicita uma nova execução de todo o conjunto de verificação da interface de usuário do pull request. Ao receber os eventos de ação `rerequested`, você deverá criar uma nova execução de verificação. Veja "Sobre verificações de status" para mais informações sobre a interface do usuário do GitHub.
`check_suite`	`objeto`	O check_suite.
`check_suite[head_branch]`	`string`	O nome do branch principal em que as alterações se encontram.
`check_suite[head_sha]`	`string`	A SHA do commit mais recente para este conjunto de verificações.
`check_suite[status]`	`string`	O status de resumo para todas as verificações que fazem parte do conjunto de verificações. Pode ser `requested`, `in_progress` ou `completed`.
`check_suite[conclusion]`	`string`	O resumo da conclusão para todas as verificações que fazem parte do conjunto de verificações. Pode ser: `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` ou `stale`. Este valor será `null` até que a execução da verificação seja `completed`.
`check_suite[url]`	`string`	A URL que aponta para o recurso da API do conjunto de verificações.
`check_suite[pull_requests]`	`array`	Um array de pull requests que correspondem a este conjunto de verificações. Um pull request corresponde a um conjunto de verificações se tiverem os mesmos `head_sha` e `head_branch`. Quando o `head_branch` do conjunto de verificações estiver em um repositório bifurcado, ele será `null` e o array `pull_requests` ficará vazio.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`ref`	`string`	O recurso `ref do git`.
`ref_type`	`string`	O tipo de objeto de ref do Git criado no repositório. Pode ser `branch` ou `tag`.
`master_branch`	`string`	The name of the repository's default branch (usually `master`).
`descrição`	`string`	Descrição atual do repositório.
`pusher_type`	`string`	The pusher type for the event. Can be either `user` or a deploy key.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada. Pode ser `criado` ou `excluído`.
`Chave`	`objeto`	O recurso de `implantar chave`.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada. Pode ser `criado`.
`implantação`	`objeto`	The implantação.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`forkee`	`objeto`	O recurso do `repositório` criado.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada. Pode ser `revogada`.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Páginas`	`array`	As páginas que foram atualizadas.
`pages[][page_name]`	`string`	O nome da página.
`pages[][title]`	`string`	O título da página atual.
`pages[][action]`	`string`	A ação que foi realizada na página. Pode ser `criado` ou `editado`.
`pages[][sha]`	`string`	O SHA de commit mais recente da página.
`pages[][html_url]`	`string`	Aponta para a página wiki de HTML.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser uma das ações a seguir: `created` - Alguém instala um aplicativo GitHub. `deleted` - Alguém desinstala aplicativo GitHub `suspend` - Alguém suspende uma instalação de aplicativo GitHub. `unsuspend` - Alguém não suspende uma instalação de aplicativo GitHub. `new_permissions_accepted` - Alguém aceita novas permissões para uma instalação de aplicativo GitHub. Quando um proprietário de aplicativo GitHub solicita novas permissões, a pessoa que instalou o aplicativo GitHub deve aceitar a nova solicitação de permissões.
`repositories`	`array`	Uma matriz de objetos do repositório que a instalação pode acessar.
`instalação`	`objeto`	A instalação de aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser `adicionado` ou `removido`.
`repository_selection`	`string`	A escolha dos repositórios em que a instalação se encontra. Pode ser `selecionado` ou `todos`.
`repositories_added`	`array`	Uma matriz de objetos do repositório adicionados à instalação.
`repositories_removed`	`array`	Um array de objetos do repositório removidos da instalação.
`instalação`	`objeto`	A instalação de aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser `criado`, `editado` ou `excluído`.
`etiqueta`	`objeto`	A etiqueta que foi adicionada.
`alterações`	`objeto`	As alterações na etiqueta se a ação foi `editada`.
`changes[name][from]`	`string`	A versão anterior do nome se a ação foi `editada`.
`changes[color][from]`	`string`	A versão anterior da cor se a ação foi `editada`.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser `created`, `closed`, `opened`, `edited` ou `deleted`.
`marco`	`objeto`	O próprio marco.
`alterações`	`objeto`	As alterações para o marco se a ação foi `editada`.
`changes[description][from]`	`string`	A versão anterior da descrição se a ação foi `editada`.
`changes[due_on][from]`	`string`	A versão anterior da data de vencimento se a ação foi `editada`.
`changes[title][from]`	`string`	A versão anterior do título se a ação foi `editada`.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`id`	`inteiro`	O identificador exclusivo da criação de páginas.
`build`	`objeto`	A Listar as criações do GitHub Pages.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`zen`	`string`	String aleatória do Github zen.
`hook_id`	`inteiro`	O ID do webhook que acionou o ping.
`hook`	`objeto`	A configuração do webhook.
`hook[app_id]`	`inteiro`	Ao registrar um novo aplicativo GitHub, GitHub Enterprise Server envia um evento de ping para a URL do webhook que você especificou no registro. O evento contém o `app_id`, que é necessário para a efetuar a autenticação em um aplicativo.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada no cartão do projeto. Pode ser `created`, `edited`, `moved`, `converted` ou `deleted`.
`alterações`	`objeto`	As alterações no cartão do projeto se a ação foi `editada` ou `convertida`.
`changes[note][from]`	`string`	A versão anterior da nota se a ação foi `editada` ou `convertida`.
`after_id`	`inteiro`	O ID do cartão que este cartão agora segue se a ação foi "movida". Será `nulo` se for o primeiro cartão em uma coluna.
`project_card`	`objeto`	O próprio cartão do projeto.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada na coluna do projeto. Pode ser `created`, `edited`, `moved` ou `deleted`.
`alterações`	`objeto`	As alterações na coluna do projeto, se a ação foi `editada`.
`changes[name][from]`	`string`	A versão anterior do nome se a ação foi `editada`.
`after_id`	`inteiro`	O id da coluna que esta coluna agora segue se a ação foi "movida". Será `nulo` se for a primeira coluna em um projeto.
`project_column`	`objeto`	A própria coluna do projeto.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A acção que foi realizada no projeto. Pode ser `created`, `edited`, `closed`, `reopened` ou `deleted`.
`alterações`	`objeto`	As alterações no projeto, se a ação foi `editada`.
`changes[name][from]`	`string`	A versão anterior do nome se a ação foi `editada`.
`changes[body][from]`	`string`	A versão anterior do texto se a ação foi `editada`.
`project`	`objeto`	O próprio projeto.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada no comentário. Pode ser `created`, `edited` ou `deleted`.
`alterações`	`objeto`	As alterações no comentário se a ação foi `editada`. `alterações[body][from]`
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`ref`	`string`	O `git ref completo` que foi empurrado. Exemplo: `refs/heads/master`.
`antes`	`string`	O SHA do último commit em `ref` antes do push.
`depois`	`string`	O SHA do último commit no `ref` após o push.
`commits`	`array`	Um array de objetos de commit, que descreve os commits carregados. (O array inclui um máximo de 20 commits. Se necessário, você pode usar a API de Commits para obter commits adicionais. Este limite é aplicado apenas aos eventos da linha do tempo e não é aplicado às entregas do webhook.)
`commits[][id]`	`string`	O SHA do commit.
`commits[][timestamp]`	`string`	O carimbo de tempo ISO 8601 do commit.
`commits[][message]`	`string`	A mensagem do commit.
`commits[][author]`	`objeto`	O autor do git do commit.
`commits[][author][name]`	`string`	O nome do autor do git.
`commits[][author][email]`	`string`	O endereço de e-mail do autor do git.
`commits[][url]`	`url`	URL que aponta para o recurso de commit de API.
`commits[][distinct]`	`boolean`	Se este compromisso é diferente de qualquer outro que tenha sido carregado anteriormente.
`commits[][added]`	`array`	Um array de arquivos adicionados no commit.
`commits[][modified]`	`array`	Um array de arquivos modificados pelo commit.
`commits[][removed]`	`array`	Um array de arquivos removidos no commit.
`pusher`	`objeto`	O usuário que fez o push dos commits.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Este pode ser um dos seguintes: `created` - Um repositório foi criado. `deleted` - Um repositório foi excluído. `archived` - Um repositório está arquivado. `unarchived` - Um repositório não está arquivado. `anonymous_access_enabled` - Um repositório está habilitado para acesso anônimo ao Git, `anonymous_access_disabled` - Um repositório está desativado para acesso anônimo ao Git `edited` - As informações de um repositório são editadas. `renamed` - Um repositório é renomeado. `transferred` - Um repositório é transferido. `publicized` - Um repositório é publicado. `privatizado` - Um repositório é privatizado.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Eventos de webhook e cargas

Objeto da carga do webhook

Exemplo de carga de webhook

Problemas

Disponibilidade

Objeto da carga do webhook

Exemplo de carga de webhook quando alguém editar um problema

etiqueta

Disponibilidade

Objeto da carga do webhook

Exemplo de carga de webhook

filiação

Disponibilidade

Objeto da carga do webhook

Exemplo de carga de webhook

meta

Disponibilidade

Objeto da carga do webhook

Objeto da carga do webhook

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. A ação pode ser `publicadas`, `atualizadas`, ou `executadas` para todos os novos eventos.
`security_advisory`	`objeto`	As informações da consultoria de segurança, incluindo resumo, descrição e gravidade.

Tecla	Tipo	Descrição
`id`	`inteiro`	O identificador exclusivo do status.
`sha`	`string`	O SHA do commit.
`estado`	`string`	O novo estado. Pode ser `pendente`, `sucesso`, `falha` ou `erro`.
`descrição`	`string`	A descrição opcional legível para pessoas adicionada ao status.
`url_destino`	`string`	O link opcional adicionado ao status.
`branches`	`array`	Um array de objetos de branch que contém o SHA do status. Cada branch contém o SHA fornecido, mas o SHA pode ou não ser o cabeçalho do branch. O array inclui, no máximo, 10 branches.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Atualmente, só pode ser `favoritada`.
`repositório`	`objeto`	O `repositório` em que o evento ocorreu.
`organização`	`objeto` Cargas do webhook contêm o objeto da `organização` quando o webhook é configurado para uma organização ou o evento ocorre a partir da atividade em um repositório pertencente a uma organização.
`instalação`	`objeto`	A instalação de aplicativo GitHub. As cargas de webhook contêm a propriedade `instalação` quando o evento é configurado para um aplicativo GitHub.
`remetente`	`objeto`	O usuário que ativou o evento.