Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

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.

As contas corporativas estão disponíveis com GitHub Enterprise Cloud e GitHub Enterprise Server. Para obter mais informações, consulte "Sobre contas corporativas."

Neste artigo

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Ou, learn how to contribute.

A API de eventos pode retornar diferentes tipos de eventos acionados por atividades no GitHub. Cada resposta ao evento contém propriedades compartilhadas, mas tem um objeto de carga único, determinado pelo seu tipo de evento. As propriedades comuns do objeto de evento descrevem as propriedades compartilhadas por todos os eventos, e cada tipo de evento descreve as propriedades da carga que são únicas para o 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.
tipoO tipo de 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 que pertence à conta de usuário octocat.
repo.urlA URL da API REST usada para recuperar o objeto do repositório, que inclui informações adicionais do repositório.
cargaO objeto da carga de eventos é único para o tipo de evento. Veja o tipo de evento abaixo para o objeto da carga da API de eventos.

Exemplo de objeto de evento WatchEvent

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

Status: 200 OK
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"
[
  {
    "type": "WatchEvent",
    "public": true,
    "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 ação do objeto da carga. Para obter mais informações, consulte a API REST de "comentário de commit".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação realizada. Pode ser criado.
comentárioobjetoO recurso de comentário de commit.

CreateEvent

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

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
refstringO recurso ref do git.
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 (normalmente principal).
descriçãostringDescrição atual do repositório.

DeleteEvent

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

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
refstringO recurso ref do git.
ref_typestringO tipo de objeto do Git ref excluído no repositório. Pode ser branch ou tag.

ForkEvent

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

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
forkeeobjetoO recurso do repositório criado.

GollumEvent

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

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
PáginasarrayAs páginas que foram atualizadas.
pages[][page_name]stringO nome da página.
pages[][title]stringO título da página atual.
pages[][action]stringA ação que foi realizada na página. Pode ser criado ou editado.
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 de um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "comentários de problema".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação realizada no comentário. Pode ser created, edited ou deleted.
alteraçõesobjeto As alterações no comentário se a ação foi editada. alterações[body][from]stringA versão anterior do texto se a ação foi editada. problemaobjeto ├O problema ao qual o comentário pertence. comentário

IssuesEvent

Atividade relacionada a um problema. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST de problemas".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser opened, closed, reopened, assigned, unassigned, labeled ou unlabeled.
issueobjectThe issue itself. changes

MemberEvent

Atividade relacionada aos colaboradores do repositório. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a APTI REST dos colaboradores".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser adicionado para indicar que um usuário aceitou um convite para um repositório.
integranteobjetoO usuário que foi adicionado. alterações

PublicEvent

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

Objeto da carga do evento

Este evento retorna um objeto de carga vazio.

PullRequestEvent

Atividade relacionada a pull requests. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte a API REST de "pull requests".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser opened, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled e synchronize.
númerointeiroO número do pull request. alterações

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 ação do objeto da carga. Para obter mais informações, consulte a API REST dos "comentários de revisão de pull request".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação realizada no comentário. Pode ser criado.
alteraçõesobjetoAs alterações no comentário se a ação foi editada. changes[body][from]

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 de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

TeclaTipoDescrição
push_idinteiroIdentificador único para o push.
sizeinteiroO número de commits no push.
distinct_sizeinteiroO número de commits distintos no push.
refstringO git ref completo que foi carregado. Exemplo: refs/heads/master.
headstringO SHA do último commit no ref após o push.
antesstringO SHA do último commit 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ê 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]stringO SHA do commit.
commits[][message]stringA mensagem do commit.
commits[][author]objetoO 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 ação do objeto da carga. Para obter mais informações, consulte a APTI REST das versões".

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser publicado.
alterações[body][from]stringA versão anterior do texto se a ação foi editada. changes[name][from]

SponsorshipEvent

Atividade relacionada a uma listagem de patrocínios. O tipo de atividade é especificado na propriedade ação do objeto da carga. Para obter mais informações, consulte "Sobre os Patrocinadores do GitHub".

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação que foi executada. Pode ser criado.
effective_datestringThe pending_cancellation and pending_tier_change event types will include the date the cancellation or tier change will take effect. changes[tier][from]

WatchEvent

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

O objeto de evento inclui propriedades comuns para todos os eventos. Cada objeto de evento inclui uma propriedade de carga e o valor é único para cada tipo de evento. O objeto de carga para este evento está descrito abaixo.

Objeto da carga do evento

TeclaTipoDescrição
AçãostringA ação que foi executada. Atualmente, só pode ser favoritada.

Did this doc help you?

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Ou, learn how to contribute.