Skip to main content

Esta versão do GitHub Enterprise Server foi descontinuada em 2024-09-24. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

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 eventoTypeDescrição
idstringIdentificador exclusivo do evento.
typestringO tipo do evento. Os eventos usam PascalCase para o nome.
actorobjectO usuário que acionou o evento.
actor.idstringO identificador único para o ator.
actor.loginstringO nome de usuário do ator.
actor.display_loginstringO formato de exibição específico do nome de usuário.
actor.gravatar_idstringO identificador único do perfil Gravatar para o ator.
actor.urlstringA URL da API REST usada para recuperar o objeto do usuário, que inclui informações adicionais sobre o usuário.
actor.avatar_urlstringA URL da imagem do perfil do ator.
repoobjectO objeto de repositório onde ocorreu o evento.
repo.idstringO identificador único do repositório.
repo.namestringO 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.urlstringA URL da API REST usada para recuperar o objeto do repositório, que inclui informações adicionais do repositório.
payloadobjectO 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.
publicbooleanSe o evento é visível a todos os usuários.
created_atstringA data e hora em que o evento foi disparado. O formato segue a ISO 8601.
orgobjectA 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.idstringO identificador exclusivo da organização.
org.loginstringO nome da organização.
org.gravatar_idstringO identificador exclusivo do perfil da organização no Gravatar.
org.urlstringA URL da API REST usada para recuperar o objeto de organização, que inclui informações adicionais da organização.
org.avatar_urlstringA 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

ChaveTypeDescriçã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 "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

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

ChaveTypeDescriçã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 "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

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

ChaveTypeDescriçã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 "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

ChaveTypeDescrição
actionstringA ação realizada no comentário. Pode ser created, edited ou deleted.
changesobjectAs alterações no comentário se a ação foi edited.
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 "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

ChaveTypeDescrição
actionstringA ação que foi executada. Pode ser opened, edited, closed, reopened, assigned, unassigned, labeled ou unlabeled.
issueobjectO próprio problema.
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 "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

ChaveTypeDescrição
actionstringA ação que foi executada. Pode ser added para indicar que um usuário aceitou um convite para um repositório.
memberobjectO usuário que foi adicionado.
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 Server.

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

ChaveTypeDescrição
actionstringA ação que foi executada. Pode ser opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled ou synchronize.
numberintegerO número da solicitação de pull.
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.

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

ChaveTypeDescriçã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 "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

ChaveTypeDescrição
actionstringA ação realizada no comentário. Pode ser created.
changesobjectAs alterações no comentário 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 à 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 para PullRequestReviewThreadEvent

ChaveTypeDescriçã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 para PushEvent

ChaveTypeDescriçã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 "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

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

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