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 | Type | Descrição |
---|---|---|
id | integer | Identificador exclusivo do evento. |
type | string | O tipo do evento. Os eventos usam PascalCase para o nome. |
actor | object | O usuário que acionou o evento. |
actor.id | integer | O identificador único para o ator. |
actor.login | string | O nome de usuário do ator. |
actor.display_login | string | O formato de exibição específico do nome de usuário. |
actor.gravatar_id | string | O identificador único do perfil Gravatar para o ator. |
actor.url | string | 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 | string | A URL da imagem do perfil do ator. |
repo | object | O objeto de repositório onde ocorreu o evento. |
repo.id | integer | O identificador único do repositório. |
repo.name | string | 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 | string | A URL da API REST usada para recuperar o objeto do repositório, que inclui informações adicionais do repositório. |
payload | object | 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 | boolean | Se o evento é visível a todos os usuários. |
created_at | string | A data e hora em que o evento foi disparado. O formato segue a ISO 8601. |
org | object | 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 | integer | O identificador exclusivo da organização. |
org.login | string | O nome da organização. |
org.gravatar_id | string | O identificador exclusivo do perfil da organização no Gravatar. |
org.url | string | A URL da API REST usada para recuperar o objeto de organização, que inclui informações adicionais da organização. |
org.avatar_url | string | 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 "Pontos de extremidade da API REST para comentários do commit".
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 para CommitCommentEvent
Chave | Type | 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 "Pontos de extremidade da API REST para banco de dados 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 para CreateEvent
Chave | Type | Descrição |
---|---|---|
ref | string | O recurso git ref , ou null se ref_type é repository . |
ref_type | string | O tipo de objeto de ref do Git criado no repositório. Pode ser branch , tag ou repository . |
master_branch | string | O nome do branch padrão do repositório (geralmente main ). |
description | string | Descrição atual do repositório. |
pusher_type | string | Pode ser user ou uma chave de implantação. |
DeleteEvent
Um branch ou tag do Git é excluído. Para obter mais informações, confira a API REST do "Pontos de extremidade da API REST para banco de dados 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 para DeleteEvent
Chave | Type | 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 "Pontos de extremidade da API REST para repositórios".
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 para ForkEvent
Chave | Type | Descrição |
---|---|---|
forkee | object | O recurso repository criado. |
GollumEvent
Uma página wiki foi criada ou atualizada. Para obter mais informações, confira "Sobre 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 para GollumEvent
Chave | Type | 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 "Pontos de extremidade da API REST para issues".
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 para IssueCommentEvent
Chave | Type | Descrição |
---|---|---|
action | string | A ação realizada no comentário. Pode ser created , edited ou deleted . |
changes | object | As alterações no comentário se a ação foi edited . |
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 "Pontos de extremidade da API REST para issues".
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 para IssuesEvent
Chave | Type | Descrição |
---|---|---|
action | string | A ação que foi executada. Pode ser opened , edited , closed , reopened , assigned , unassigned , labeled ou unlabeled . |
issue | object | O próprio problema. |
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 "Pontos de extremidade da API REST para 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 para MemberEvent
Chave | Type | 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 | object | O usuário que foi adicionado. |
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.
Objeto payload
do evento para PublicEvent
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 "Pontos de extremidade da API REST para pull requests".
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 para PullRequestEvent
Chave | Type | 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 | integer | O número da solicitação de pull. |
changes | object | As alterações no comentário 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 . |
pull_request | object | A solicitação de pull em si. |
reason | string | O motivo pelo qual a solicitação de pull foi removida de uma fila de mesclagem se a ação foi dequeued . |
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 "Pontos de extremidade da API REST para pull requests".
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 para PullRequestReviewEvent
Chave | Type | 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 "Pontos de extremidade da API REST para pull requests".
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 para PullRequestReviewCommentEvent
Chave | Type | Descrição |
---|---|---|
action | string | A ação realizada no comentário. Pode ser created . |
changes | object | As alterações no comentário se a ação foi edited . |
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 para PullRequestReviewThreadEvent
Chave | Type | Descrição |
---|---|---|
action | string | A ação que foi executada. Pode ser uma das ações a seguir:
|
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 para PushEvent
Chave | Type | 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 "Pontos de extremidade da API REST para lançamentos e ativos de lançamento".
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 para ReleaseEvent
Chave | Type | Descrição |
---|---|---|
action | string | A ação que foi executada. Pode ser published . |
changes[body][from] | string | A versão anterior do corpo se a ação foi edited . |
changes[name][from] | string | A versão anterior do nome se a ação foi edited . |
release | object | O objeto release. |
SponsorshipEvent
Atividade relacionada a uma listagem de patrocínios. O tipo de atividade é especificado na propriedade action
do objeto de conteúdo. Para obter mais informações, confira "Sobre o GitHub Sponsors".
Objeto payload
do evento para SponsorshipEvent
Chave | Type | Descrição |
---|---|---|
action | string | A ação que foi executada. Ele pode ser created . |
effective_date | string | Os tipos de eventos pending_cancellation e pending_tier_change incluirão a data em que o cancelamento ou a alteração de camada entrarão em vigor. |
changes[tier][from] | object | O tier_changed e o pending_tier_change incluirão a camada original antes da alteração ou da alteração pendente. Para obter mais informações, confira o conteúdo de alteração de camada pendente. |
changes[privacy_level][from] | string | Os tipos de eventos edited incluem os detalhes sobre a alteração quando alguém edita um patrocínio para alterar a privacidade. |
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 "Pontos de extremidade da API REST para atividade".
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 para WatchEvent
Chave | Type | Descrição |
---|---|---|
action | string | A ação que foi executada. Atualmente, só pode ser started . |