Tipos de eventos do GitHub

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 evento	Descrição
`id`	Identificador exclusivo do evento.
`tipo`	O tipo de 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` que pertence à conta de usuário `octocat`.
`repo.url`	A URL da API REST usada para recuperar o objeto do repositório, que inclui informações adicionais do repositório.
`carga`	O 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.

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 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.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada. Pode ser `criado`.
`comentário`	`objeto`	O recurso de comentário de commit.

Tecla	Tipo	Descrição
`ref`	`string`	O recurso `ref do git`.
`ref_type`	`string`	O tipo de objeto de ref do Git criado no repositório. Pode ser `branch` ou `tag`.
`master_branch`	`string`	The name of the repository's default branch (usually `master`).
`descrição`	`string`	Descrição atual do repositório.

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

Tecla	Tipo	Descrição
`Ação`	`string`	A ação realizada no comentário. Pode ser `created`, `edited` ou `deleted`.
`alterações`「`objeto` As alterações no comentário se a ação foi `editada`. `alterações[body][from]`	`string`	A versão anterior do texto se a ação foi `editada`. `problema`├`objeto` ├O problema ao qual o comentário pertence. `comentário`

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser `opened`, `closed`, `reopened`, `assigned`, `unassigned`, `labeled` ou `unlabeled`.
`problema`	`objeto`	O próprio problema. `alterações`

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser `adicionado` para indicar que um usuário aceitou um convite para um repositório.
`integrante`	`objeto`	O usuário que foi adicionado. `alterações`

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser `criado`.
`pull_request`	`objeto`	O pull request ao qual a revisão pertence.
`revisar`	`objeto`	A revisão que foi afetada.

Tecla	Tipo	Descrição
`push_id`	`inteiro`	Identificador único para o push.
`size`	`inteiro`	O número de commits no push.
`distinct_size`	`inteiro`	O número de commits distintos no push.
`ref`	`string`	O `git ref completo` que foi empurrado. Exemplo: `refs/heads/master`.
`head`	`string`	O SHA do último commit no `ref` após o push.
`antes`	`string`	O SHA do último commit 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 obter 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]`	`objeto`	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.

Tecla	Tipo	Descrição
`Ação`	`string`	A ação que foi executada. Pode ser `publicado`.
`alterações[body][from]`	`string`	A versão anterior do texto se a ação foi `editada`. `changes[name][from]`

Tipos de eventos do GitHub

Ainda precisa de ajuda?