Skip to main content

Tipos de eventos do GitHub

Para a API de eventos de GitHub, saiba sobre cada tipo de evento, a ação de acionamento em GitHub e as propriedades exclusivas de cada evento.

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 eventoDescrição
idIdentificador exclusivo do evento.
typeO tipo do evento. Os eventos usam PascalCase para o nome.
actorO usuário que acionou o evento.
actor.idO identificador único para o ator.
actor.loginO nome de usuário do ator.
actor.display_loginO formato de exibição específico do nome de usuário.
actor.gravatar_idO identificador único do perfil Gravatar para o ator.
actor.urlA URL da API REST usada para recuperar o objeto do usuário, que inclui informações adicionais sobre o usuário.
actor.avatar_urlA URL da imagem do perfil do ator.
repoO objeto de repositório onde ocorreu o evento.
repo.idO identificador único do repositório.
repo.nameO 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.urlA URL da API REST usada para recuperar o objeto do repositório, que inclui informações adicionais do repositório.
payloadO 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.
publicSe o evento é visível a todos os usuários.
created_atA data e hora em que o evento foi disparado. O formato segue a ISO 8601.
orgA 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.idO identificador exclusivo da organização.
org.loginO nome da organização.
org.gravatar_idO identificador exclusivo do perfil da organização no Gravatar.
org.urlA URL da API REST usada para recuperar o objeto de organização, que inclui informações adicionais da organização.
org.avatar_urlA 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

ChaveTipoDescrição
actionstringA ação executada. Pode ser created.
commentobjectO 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

ChaveTipoDescrição
refstringO recurso git ref.
ref_typestringO tipo de objeto de ref do Git criado no repositório. Pode ser branch ou tag.
master_branchstringO nome do branch padrão do repositório (geralmente main).
descriptionstringDescriçã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

ChaveTipoDescrição
refstringO recurso git ref.
ref_typestringO 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

ChaveTipoDescrição
forkeeobjectO 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

ChaveTipoDescrição
pagesarrayAs páginas que foram atualizadas.
pages[][page_name]stringO nome da página.
pages[][title]stringO título de página atual.
pages[][action]stringA ação que foi executada na página. Pode ser created ou edited.
pages[][sha]stringO SHA de commit mais recente da página.
pages[][html_url]stringAponta 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

ChaveTipoDescrição
actionstringA ação realizada no comentário. Pode ser created, edited ou deleted. changes
changes[body][from]stringA versão anterior do corpo se a ação foi edited.
issueobjectO problema ao qual o comentário pertence.
commentobjectO 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

ChaveTipoDescrição
actionstringA ação que foi executada. Pode ser opened, edited, closed, reopened, assigned, unassigned, labeled ou unlabeled. issue
changesobjectAs alterações no problema se a ação foi edited.
changes[title][from]stringA versão anterior do título se a ação foi edited.
changes[body][from]stringA versão anterior do corpo se a ação foi edited.
assigneeobjectO usuário opcional que foi atribuído ou teve a atribuição cancelada ao problema.
labelobjectO 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

ChaveTipoDescrição
actionstringA ação que foi executada. Pode ser added para indicar que um usuário aceitou um convite para um repositório. member
changesobjectAs alterações nas permissões do colaborador se a ação foi edited.
changes[old_permission][from]stringAs 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 Cloud.

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

ChaveTipoDescrição
actionstringA ação que foi executada. Pode ser opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled ou synchronize. number
changesobjectAs alterações no comentário se a ação foi edited.
changes[title][from]stringA versão anterior do título se a ação foi edited.
changes[body][from]stringA versão anterior do corpo se a ação foi edited.
pull_requestobjectA solicitação de pull em si. reason

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

ChaveTipoDescrição
actionstringA ação que foi executada. Pode ser created.
pull_requestobjectO pull request ao qual a revisão pertence.
reviewobjectA 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

ChaveTipoDescrição
actionstringA ação realizada no comentário. Pode ser created. changes
changes[body][from]stringA versão anterior do corpo se a ação foi edited.
pull_requestobjectA solicitação de pull à qual o comentário pertence.
commentobjectO 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

ChaveTipoDescrição
actionstringA 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_requestobjectA solicitação de pull à qual o thread pertence.
threadobjectO 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

ChaveTipoDescrição
push_idintegerIdentificador único para o push.
sizeintegerO número de commits no push.
distinct_sizeintegerO número de commits distintos no push.
refstringA git ref completa que foi enviada por push. Exemplo: refs/heads/main.
headstringO SHA do commit mais recente em ref após o push.
beforestringO SHA do commit mais recente em ref antes do push.
commitsarrayUm 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]stringO SHA do commit.
commits[][message]stringA mensagem do commit.
commits[][author]objectO autor do git do commit.
commits[][author][name]stringO nome do autor do git.
commits[][author][email]stringO endereço de e-mail do autor do git.
commits[][url]urlURL que aponta para o recurso de commit de API.
commits[][distinct]booleanSe 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

ChaveTipoDescrição
actionstringA ação que foi executada. Pode ser published. changes[body][from]
changes[name][from]stringA versão anterior do nome se a ação foi edited.
releaseobjectO 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 os Patrocinadores do GitHub".

Objeto payload do evento

ChaveTipoDescrição
actionstringA ação que foi executada. Ele pode ser created. effective_date
changes[tier][from]objectO 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]stringOs 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 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

ChaveTipoDescrição
actionstringA ação que foi executada. Atualmente, só pode ser started.