Tipos de eventos do GitHub

A API de eventos pode retornar diferentes tipos de eventos acionados por atividades no GitHub. Cada resposta de evento contém propriedades compartilhadas, mas tem um objeto payload exclusivo determinado pelo tipo de evento. As propriedades comuns do objeto Event descrevem as propriedades compartilhadas por todos os eventos, e cada tipo de evento descreve as propriedades payload exclusivas do evento específico.

Propriedades comuns do objeto de evento

Os objetos de evento retornados dos pontos de extremidade da API de eventos têm a mesma estrutura.

Nome do atributo da API do evento	Descrição
id	Identificador exclusivo do evento.
type	O tipo do evento. Os eventos usam PascalCase para o nome.
actor	O usuário que acionou o evento.
actor.id	O identificador único para o ator.
actor.login	O nome de usuário do ator.
actor.display_login	O formato de exibição específico do nome de usuário.
actor.gravatar_id	O identificador único do perfil Gravatar para o ator.
actor.url	A URL da API REST usada para recuperar o objeto do usuário, que inclui informações adicionais sobre o usuário.
actor.avatar_url	A URL da imagem do perfil do ator.
repo	O objeto de repositório onde ocorreu o evento.
repo.id	O identificador único do repositório.
repo.name	O nome do repositório, que inclui o proprietário e o nome do repositório. Por exemplo, octocat/hello-world é o nome do repositório hello-world pertencente �  conta pessoal octocat.
repo.url	A URL da API REST usada para recuperar o objeto do repositório, que inclui informações adicionais do repositório.
payload	O objeto da carga de eventos é único para o tipo de evento. Confira o tipo de evento abaixo para ver o objeto payload da API de evento.
public	Se o evento é visível a todos os usuários.
created_at	A data e hora em que o evento foi disparado. O formato segue a ISO 8601.
org	A organização que foi escolhida pelo ator para executar uma ação que dispara o evento. A propriedade será exibida no objeto de evento somente se for aplicável.
org.id	O identificador exclusivo da organização.
org.login	O nome da organização.
org.gravatar_id	O identificador exclusivo do perfil da organização no Gravatar.
org.url	A URL da API REST usada para recuperar o objeto de organização, que inclui informações adicionais da organização.
org.avatar_url	A URL da imagem de perfil da organização.

Exemplo de objeto de evento WatchEvent

Este exemplo mostra o formato da resposta WatchEvent ao usar a API de Eventos.

HTTP/2 200
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"

[
  {
    "type": "WatchEvent",
    "public": false,
    "payload": {
    },
    "repo": {
      "id": 3,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "actor": {
      "id": 1,
      "login": "octocat",
      "gravatar_id": "",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "url": "https://api.github.com/users/octocat"
    },
    "org": {
      "id": 1,
      "login": "github",
      "gravatar_id": "",
      "url": "https://api.github.com/orgs/github",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif"
    },
    "created_at": "2011-09-06T17:26:27Z",
    "id": "12345"
  }
]

CommitCommentEvent

Um comentário de commit foi criado. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "comentário sobre commits".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação executada. Pode ser created.
comment	object	O recurso de comentário sobre o commit.

CreateEvent

Um branch ou tag do Git é criado. Para obter mais informações, confira a API REST do "Banco de Dados do Git".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
ref	string	O recurso git ref.
ref_type	string	O tipo de objeto de ref do Git criado no repositório. Pode ser branch ou tag.
master_branch	string	O nome do branch padrão do repositório (geralmente main).
description	string	Descrição atual do repositório.

DeleteEvent

Um branch ou tag do Git é excluído. Para obter mais informações, confira a API REST do "Banco de Dados do Git".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
ref	string	O recurso git ref.
ref_type	string	O tipo de objeto de referência do Git excluído no repositório. Pode ser branch ou tag.

ForkEvent

Um usuário bifurca um repositório. Para obter mais informações, confira a REST API de "forks".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
forkee	object	O recurso repository criado.

GollumEvent

Uma página wiki foi criada ou atualizada. Para obter mais informações, confira "Sobre os wikis".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
pages	array	As páginas que foram atualizadas.
pages[][page_name]	string	O nome da página.
pages[][title]	string	O título de página atual.
pages[][action]	string	A ação que foi executada na página. Pode ser created ou edited.
pages[][sha]	string	O SHA de commit mais recente da página.
pages[][html_url]	string	Aponta para a página wiki de HTML.

IssueCommentEvent

Atividade relacionada a um comentário sobre um problema ou sobre uma solicitação de pull. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "comentários sobre problemas".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação realizada no comentário. Pode ser created, edited ou deleted. changes
changes[body][from]	string	A versão anterior do corpo se a ação foi edited.
issue	object	O problema ao qual o comentário pertence.
comment	object	O comentário em si.

IssuesEvent

Atividade relacionada a um problema. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "problemas".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação que foi executada. Pode ser opened, edited, closed, reopened, assigned, unassigned, labeled ou unlabeled. issue
changes	object	As alterações no problema se a ação foi edited.
changes[title][from]	string	A versão anterior do título se a ação foi edited.
changes[body][from]	string	A versão anterior do corpo se a ação foi edited.
assignee	object	O usuário opcional que foi atribuído ou teve a atribuição cancelada ao problema.
label	object	O rótulo opcional que foi adicionado ou removido do problema.

MemberEvent

Atividade relacionada aos colaboradores do repositório. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "colaboradores".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação que foi executada. Pode ser added para indicar que um usuário aceitou um convite para um repositório. member
changes	object	As alterações nas permissões do colaborador se a ação foi edited.
changes[old_permission][from]	string	As permissões anteriores do colaborador se a ação foi edited.

PublicEvent

Quando um repositório privado torna-se público. Sem dúvida: o melhor evento de GitHub Enterprise Server.

Objeto payload do evento

Esse evento retorna um objeto payload vazio.

PullRequestEvent

Atividade relacionada a pull requests. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "solicitações de pull".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação que foi executada. Pode ser opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled ou synchronize. number
changes	object	The changes to the comment if the action was edited.
changes[title][from]	string	The previous version of the title if the action was edited.
changes[body][from]	string	The previous version of the body if the action was edited.
pull_request	object	The pull request itself.

PullRequestReviewEvent

Atividade relacionada a revisões de pull request. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "revisões de solicitação de pull".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação que foi executada. Pode ser created.
pull_request	object	O pull request ao qual a revisão pertence.
review	object	A revisão que foi afetada.

PullRequestReviewCommentEvent

Atividade relacionada aos comentários de revisão do pull request no diff unificado do pull request. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "comentários de revisão de solicitações de pull".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação realizada no comentário. Pode ser created. changes
changes[body][from]	string	A versão anterior do corpo se a ação foi edited.
pull_request	object	A solicitação de pull �  qual o comentário pertence.
comment	object	O comentário em si.

PullRequestReviewThreadEvent

Atividade relacionada a um thread de comentários em uma solicitação de pull que está sendo marcada como resolvida ou não resolvida. O tipo de atividade é especificado na propriedade action do objeto de conteúdo.

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação que foi executada. Pode ser uma das ações a seguir: resolved – um thread de comentário em uma solicitação de pull foi marcado como resolvido. unresolved – um thread de comentário resolvido anteriormente em uma solicitação de pull foi marcado como não resolvido.
pull_request	object	A solicitação de pull �  qual o thread pertence.
thread	object	O thread que foi afetado.

PushEvent

Um ou mais commits são enviados para uma branch ou tag de um repositório.

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
push_id	integer	Identificador único para o push.
size	integer	O número de commits no push.
distinct_size	integer	O número de commits distintos no push.
ref	string	A git ref completa que foi enviada por push. Exemplo: refs/heads/main.
head	string	O SHA do commit mais recente em ref após o push.
before	string	O SHA do commit mais recente em ref antes do 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 buscar 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]	object	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.

ReleaseEvent

Atividade relacionada a uma versão. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "versões".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação que foi executada. Pode ser published. changes[body][from]
changes[name][from]	string	A versão anterior do nome se a ação foi edited.
release	object	O objeto release.

WatchEvent

Quando alguém marca um repositório com uma estrela. O tipo de atividade é especificado na propriedade action do objeto de conteúdo. Para obter mais informações, confira a API REST de "marcação com estrelas".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade payload e o valor é exclusivo para cada tipo de evento. O objeto payload para esse evento é descrito abaixo.

Objeto payload do evento

Chave	Tipo	Descrição
action	string	A ação que foi executada. Atualmente, só pode ser started.