Eventos de webhook e cargas

Para cada evento de webhook, você pode revisar quando o evento ocorrer, uma carga de exemplo, bem como as descrições sobre os parâmetros do objeto da carga.

As contas corporativas estão disponíveis com GitHub Enterprise Cloud e GitHub Enterprise Server.

Webhooks configurados em contas corporativas ou organizações que fazem parte de uma conta corporativa incluirão um objeto da conta enterprise.

Neste artigo

Propriedades comuns do objeto da carga do webhook
check_run
check_suite
commit_comment
content_reference
create
delete
deploy_key
implantação
implantação_status
enterprise
bifurcação
github_app_authorization
gollum
instalação
installation_repositories
issue_comment
Problemas
etiqueta
integrante
filiação
meta
marco
organization
page_build
ping
project_card
project_column
project
público
pull_request
pull_request_review
pull_request_review_comment
push
versão
repositório
security_advisory
estrela
status
equipe
team_add
usuário
inspecionar
workflow_run

When configuring a webhook, you can use the UI or API to choose which events will send you payloads. Only subscribing to the specific events you plan on handling limits the number of HTTP requests to your server. You can also subscribe to all current and future events. By default, webhooks are only subscribed to the push event. You can change the list of subscribed events anytime.

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.

sender | object | The user that triggered the event. Esta propriedade está incluída em todas as cargas do webhook. repository | object | The repository where the event occured. As cargas do webhook contêm a propriedade

repository quando ocorre o evento a partir da atividade em um repositório. organization | object | Webhook payloads contain the organization object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization. installation | object | The aplicativo GitHub installation. Webhook payloads contain the installation property when the event is configured for and sent to a aplicativo GitHub. Para obter mais informações, consulte "Criar um aplicativo GitHub.

As propriedades únicas para um evento de webhook são as mesmas que você encontrará na propriedade carga ao usar a API de eventos. 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 do GitHub Enterprise Server que enviou a carga HTTP POST.
`X-Hub-Signature`	O resumo hexadecimal de HMAC no texto da resposta. Este cabeçalho será enviado se o webhook for configurado com um `secredo`. O resumo hexadecimal de HMAC é gerado usando a função hash `sha1` e o `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/1.1

> 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

Check run activity has occurred. The type of activity is specified in the action property of the payload object. For more information, see the "check runs" REST API.

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 uma array pull_requests vazio e um valor null para head_branch.

Tecla	Tipo	Descrição
`Ação`	`string`	The action performed. Can be one of: `created` - A new check run was created. `completed` - The `status` of the check run is `completed`. `rerequested` - Someone requested to re-run your check run from the pull request UI. See "About status checks" for more details about the GitHub UI. When you receive a `rerequested` action, you'll need to create a new check run. Only the aplicativo GitHub that someone requests to re-run the check will receive the `rerequested` payload. `requested_action` - Someone requested an action your app provides to be taken. Only the aplicativo GitHub someone requests to perform an action will receive the `requested_action` payload. To learn more about check runs and requested actions, see "Check runs and requested actions."
`check_run`	`objeto`	The check_run.
`check_run[status]`	`string`	The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
`check_run[conclusion]`	`string`	The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. This value will be `null` until the check run has `completed`.
`check_run[name]`	`string`	The name of the check run.
`check_run[check_suite][id]`	`integer`	The id of the check suite that this check run is part of.
`requested_action`	`objeto`	The action requested by the user.
`requested_action[identifier]`	`string`	The integrator reference of the action requested by the user.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	The action performed. Can be: `completed` - All check runs in a check suite have completed. `requested` - Occurs when new code is pushed to the app's repository. When you receive the `requested` action events, you'll need to create a new check run. `rerequested` - Occurs when someone requests to re-run the entire check suite from the pull request UI. When you receive the `rerequested` action events, you'll need to create a new check run. See "About status checks" for more details about the GitHub UI.
`check_suite`	`objeto`	The check_suite.
`check_suite[head_branch]`	`string`	The head branch name the changes are on.
`check_suite[head_sha]`	`string`	The SHA of the most recent commit for this check suite.
`check_suite[status]`	`string`	The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
`check_suite[conclusion]`	`string`	The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. This value will be `null` until the check run has `completed`.
`check_suite[url]`	`string`	URL that points to the check suite API resource.
`check_suite[pull_requests]`	`array`	An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `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.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	The action performed. Can be `created`.
`comentário`	`objeto`	The commit comment resource.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`ref`	`string`	The `git ref` resource.
`ref_type`	`string`	The type of Git ref object created in the repository. Can be either `branch` or `tag`.
`master_branch`	`string`	The name of the repository's default branch (usually `master`).
`descrição`	`string`	The repository's current description.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	The action performed. Can be either `created` or `deleted`.
`Chave`	`objeto`	The `deploy key` resource.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`implantação`	`objeto`	The implantação.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`implantação_status`	`objeto`	O estado de implantação.
`deployment_status["state"]`	`string`	O novo estado. Pode ser `pendente`, `sucesso`, `falha` ou `erro`.
`deployment_status["target_url"]`	`string`	O link opcional adicionado ao status.
`deployment_status["description"]`	`string`	A descrição opcional legível para pessoas adicionada ao status.
`implantação`	`objeto`	A implantação à qual este status está associado.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`forkee`	`objeto`	The created `repository` resource.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada. Pode ser `revogada`.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Páginas`	`array`	The pages that were updated.
`pages[][page_name]`	`string`	The name of the page.
`pages[][title]`	`string`	The current page title.
`pages[][action]`	`string`	The action that was performed on the page. Can be `created` or `edited`.
`pages[][sha]`	`string`	The latest commit SHA of the page.
`pages[][html_url]`	`string`	Points to the HTML wiki page.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Can be one of: `created` - Someone installs a aplicativo GitHub. `deleted` - Someone uninstalls a aplicativo GitHub `new_permissions_accepted` - Someone accepts new permissions for a aplicativo GitHub installation. When a aplicativo GitHub owner requests new permissions, the person who installed the aplicativo GitHub must accept the new permissions request.
`repositórios`	`array`	An array of repository objects that the insatllation can access.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Can be either `added` or `removed`.
`repository_selection`	`string`	The choice of repositories the installation is on. Can be either `selected` or `all`.
`repositories_added`	`array`	An array of repository objects, which were added to the installation.
`repositories_removed`	`array`	An array of repository objects, which were removed from the installation.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

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`.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Can be one of `created`, `closed`, `opened`, `edited`, or `deleted`.
`marco`	`objeto`	The milestone itself.
`changes`	`objeto`	The changes to the milestone if the action was `edited`.
`changes[description][from]`	`string`	The previous version of the description if the action was `edited`.
`changes[due_on][from]`	`string`	The previous version of the due date if the action was `edited`.
`changes[title][from]`	`string`	The previous version of the title if the action was `edited`.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

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.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

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 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.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	The action performed on the project card. Can be `created`, `edited`, `moved`, `converted`, or `deleted`.
`changes`	`objeto`	The changes to the project card if the action was `edited` or `converted`.
`changes[note][from]`	`string`	The previous version of the note if the action was `edited` or `converted`.
`after_id`	`integer`	The id of the card that this card now follows if the action was "moved". Will be `null` if it is the first card in a column.
`project_card`	`objeto`	The project card itself.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	The action that was performed on the project column. Can be one of `created`, `edited`, `moved` or `deleted`.
`changes`	`objeto`	The changes to the project column if the action was `edited`.
`changes[name][from]`	`string`	The previous version of the name if the action was `edited`.
`after_id`	`integer`	The id of the column that this column now follows if the action was "moved". Will be `null` if it is the first column in a project.
`project_column`	`objeto`	The project column itself.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	The action that was performed on the comment. Can be one of `created`, `edited`, or `deleted`.
`changes`	`object`	The changes to the comment if the action was `edited`. `changes[body][from]`
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`ref`	`string`	O `git ref` completo que foi carregado. 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ê poderá usar a API de commits para recuperar commits adicionais. Este limite é aplicado apenas aos eventos da linha do tempo e não é aplicado às entregas do webhook.)
`commits[][sha]`	`string`	O SHA 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.
`pusher`	`objeto`	O usuário que fez o push dos commits.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

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. Este pode ser um dos seguintes: `created` - Um repositório foi criado. `deleted` - Um repositório foi excluído. Este tipo de evento está disponível apenas para hooks de organização `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 do Git, `anonymous_access_disabled` - Um repositório está desabilitado para acesso anônimo do 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.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

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
`Ação`	`string`	The action performed. Can be `created` or `deleted`.
`starred_at`	`string`	The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`sender`	`object`	The user that triggered the event.

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.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Currently, can only be `started`.
`repository`	`object`	The `repository` where the event occured.
`organization`	`object`	Webhook payloads contain the `organization` object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization.
`installation`	`object`	The aplicativo GitHub installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a aplicativo GitHub.
`sender`	`object`	The user that triggered the event.