tipos de eventos GitHub

La API de eventos puede devolver diferentes tipos de eventos desencadenados por la actividad en GitHub. Cada respuesta de evento contiene propiedades compartidas, pero tiene un objeto payload único determinado por su tipo de evento. En Propiedades comunes del objeto de evento se describen las propiedades compartidas por todos los eventos y cada tipo de evento describe las propiedades payload que son únicas para el evento específico.

Propiedades comunes del objeto de los eventos

Los objetos de eventos que se devuelven de los puntos finales de la API de Eventos tienen la misma estructura.

Nombre del atributo de la API del Evento	Tipo	Descripción
`id`	`integer`	Identificador único para el evento
`type`	`string`	Tipo del evento. Los eventos utilizan PascalCase para el nombre.
`actor`	`object`	El usuario que activó el evento.
`actor.id`	`integer`	El identificador único para el actor.
`actor.login`	`string`	El nombre de usuario del actor.
`actor.display_login`	`string`	El formato de visualización específico para el nombre de usuario.
`actor.gravatar_id`	`string`	El identificador único del perfil de Gravatar para el actor.
`actor.url`	`string`	La URL de la API de REST que se utiliza para recuperar el objeto del usuario, el cual incluye información adicional del usuario.
`actor.avatar_url`	`string`	La URL de la imagen de perfil del actor.
`repo`	`object`	El objeto del repositorio en donde ocurrió el evento.
`repo.id`	`integer`	El identificador único del repositorio.
`repo.name`	`string`	El nombre del repositorio, que incluye el nombre del propietario y el nombre del repositorio. Por ejemplo, `octocat/hello-world` es el nombre del repositorio `hello-world` que pertenece a la cuenta personal `octocat`.
`repo.url`	`string`	La URL de la API de REST que se utiliza para recuperar el objeto del repositorio, el cual incluye información adicional sobre dicho repositorio.
`payload`	`object`	El objeto de carga útil del evento es exclusivo del tipo de evento. Vea el tipo de evento siguiente para el objeto de API `payload`.
`public`	`boolean`	Si el evento es visible para todos los usuarios.
`created_at`	`string`	La fecha y hora en que se desencadenó el evento. Tiene formato de conformidad con la ISO 8601.
`org`	`object`	La organización que ha elegido el actor para realizar la acción que desencadena el evento.

          _La propiedad aparece en el objeto de evento solo si es aplicable._ |

Ejemplo de objeto de evento WatchEvent

En este ejemplo se muestra el formato de la respuesta WatchEvent cuando se usa Events API.

HTTP/2 200
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"

[
  {
    "id": "12345",
    "type": "WatchEvent",
    "actor": {
      "id": 1,
      "login": "octocat",
      "display_login": "octocat",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif"
    },
    "repo": {
      "id": 3,
      "name": "octocat/Hello-World",
      "url": "https://api.github.com/repos/octocat/Hello-World"
    },
    "payload": {
      "action": "started"
    },
    "public": false,
    "created_at": "2011-09-06T17:26:27Z",
    "org": {
      "id": 1,
      "login": "github",
      "gravatar_id": "",
      "url": "https://api.github.com/orgs/github",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif"
    },
  }
]

CommitCommentEvent

Se creó un comentario de una confirmación. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta Puntos de conexión de la API de REST para comentarios de confirmaciones.

El objeto de evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad payload y el valor es único para cada tipo de evento. El objeto payload de este evento se describe a continuación.

Objeto de evento `payload` para CommitCommentEvent

Clave	Tipo	Descripción
`action`	`string`	acción realizada. Puede ser `created`.
`comment`	`object`	Recurso de comentario de confirmación.

CreateEvent

Se crea una rama o etiqueta de Git. Para más información, consulta Puntos de conexión de la API de REST para la base de datos de Git.

Objeto de evento `payload` para CreateEvent

Clave	Tipo	Descripción
`ref`	`string`	La rama `git ref` de recursos o `null` si `ref_type` es `repository`.
`ref_type`	`string`	El tipo de objeto de Git ref que se creó en el repositorio. Puede ser `branch`, `tag` o `repository`.
`full_ref`	`string`	El recurso ref con formato completo, lo que significa que para las ramas el formato es `refs/heads/<branch_name>`.
`master_branch`	`string`	El nombre de la rama predeterminada del repositorio (a menudo `main`).
`description`	`string`	La descripción actual del repositorio.
`pusher_type`	`string`	Puede ser `user` o una clave de implementación.

EliminarEvento

Se borra una rama o etiqueta de Git. Para más información, consulta la API REST de Puntos de conexión de la API de REST para la base de datos de Git.

Objeto de evento `payload` para DeleteEvent

Clave	Tipo	Descripción
`ref`	`string`	Rama de recursos de `git ref`.
`ref_type`	`string`	El tipo de objeto de referencia de Git eliminado en el repositorio. Puede ser `branch` o `tag`.
`full_ref`	`string`	El recurso ref con formato completo, lo que significa que para las ramas el formato es `refs/heads/<branch_name>`.
`pusher_type`	`string`	Puede ser `user` o una clave de implementación.

EventoDeDiscusión

Se crea una discusión en un repositorio. Para más información, consulta documentación GitHub Discussions.

Objeto de evento `payload` para DiscussionEvent

Key	Tipo	Description
`action`	`string`	acción realizada. Puede ser `created`.
`discussion`	`object`	Discusión que se creó.

ForkEvent

Un usuario bifurca un repositorio. Para más información, consulta Puntos de conexión de la API de REST para repositorios.

Objeto de evento `payload` para ForkEvent

Clave	Tipo	Descripción
`action`	`string`	acción realizada. Puede ser `forked`.
`forkee`	`object`	Recurso `repository` creado.

GollumEvent

Se crea o actualiza una página de wiki. Para más información, consulta Acerca de las wikis.

Objeto de evento `payload` para GollumEvent

Clave	Tipo	Descripción
`pages`	`array`	Las páginas que se actualizaron.
`pages[][page_name]`	`string`	Nombre de la página.
`pages[][title]`	`string`	El título de página actual.
`pages[][summary]`	`string`	Nota opcional sobre la página. Puede ser `null`.
`pages[][action]`	`string`	La acción que se realizó en la página. Puede ser `created` o `edited`.
`pages[][sha]`	`string`	El SHA de confirmación más reciente de la página.
`pages[][html_url]`	`string`	Apunta a la página de wiki de HMTL.

IssueCommentEvent

Actividad relacionada con un comentario a una propuesta o solicitud de cambios. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consultaPuntos de conexión de la API de REST para incidencias.

Objeto de evento `payload` para IssueCommentEvent

Clave	Tipo	Descripción
`action`	`string`	La acción que se realizó en el comentario. Puede ser `created`.
`issue`

          |
          `object` | [Problema](/rest/issues) al que pertenece el comentario.

          `comment`
          |
          `object` | El propio [comentario](/rest/issues#comments).

IssuesEvent

La actividar relacionada con un informe de problemas. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consultaPuntos de conexión de la API de REST para incidencias.

Objeto de evento `payload` para IssuesEvent

Clave	Tipo	Descripción
`action`	`string`	La acción que se ha realizado. Puede ser uno de `opened`, `closed`, `reopened`.
`issue`

          |
          `object` | La propia [incidencia](/rest/issues).

| | assignee|object | El usuario opcional que fue asignado o desasignado de la incidencia.

          `assignees`
          |
          `array` | Matriz opcional de objetos de asignados que detalla a los responsables de la incidencia.

          `label`
          |
          `object` | Etiqueta opcional que se ha agregado a la incidencia o se ha quitado de ella.

          `labels`
          |
          `array` | Matriz opcional de objetos de etiqueta que describen las etiquetas del problema.

| |

MemberEvent

La actividad relacionada con los colaboradores del repositorio. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta Puntos de conexión de la API de REST para colaboradores.

Objeto de evento `payload` para MemberEvent

Clave	Tipo	Descripción
`action`	`string`	La acción que se ha realizado. Puede ser `added` para indicar que un usuario ha aceptado una invitación a un repositorio.
`member`

          |
          `object` | [Usuario](/rest/users) que se ha agregado.

La actividad relacionada con las solicitudes de extracción. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta Puntos de conexión de la API REST para solicitudes de incorporación de cambios.

Objeto de evento `payload` para PullRequestEvent

Clave	Tipo	Descripción
`action`	`string`	La acción que se ha realizado. Puede ser de tipo `opened`, `closed`, `merged`, `reopened`, `assigned`, `unassigned`, `labeled` o `unlabeled`.
`number`

          |
          `integer` | Número de la solicitud de incorporación de cambios.

          `pull_request`
          |
          `object` | El [Pull Request](/rest/pulls).

| | assignee|object | El usuario opcional que fue asignado o desasignado de la incidencia.

          `assignees`
          |
          `array` | Matriz opcional de objetos de asignados que detalla a los responsables de la incidencia.

          `label`
          |
          `object` |  Etiqueta opcional que se agregó o quitó del problema si la acción era `labeled` o `unlabeled`.

          `labels`
          |
          `array` | Matriz opcional de objetos de etiqueta que describen las etiquetas de la solicitud de incorporación de cambios si la acción era `labeled` o `unlabeled`.

| |

PullRequestReviewEvent

La actividad relacionada con las revisiones de la solicitudes de extracción. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta Puntos de conexión de la API REST para solicitudes de incorporación de cambios.

Objeto de evento `payload` para PullRequestReviewEvent

Key	Tipo	Description
`action`	`string`	La acción que se ha realizado. Puede ser `created`, `updated` o `dismissed`.
`pull_request`	`object`	La solicitud de incorporación de cambios a la que pertenece la revisión.
`review`	`object`

          [Revisión](/rest/pulls) que se ha visto afectada.

PullRequestReviewCommentEvent

La actividar relacionada con los comentarios de revisión de la solicitud de extracción en el diff unificado de la misma. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta Puntos de conexión de la API REST para solicitudes de incorporación de cambios.

Objeto de evento `payload` para PullRequestReviewCommentEvent

Clave	Tipo	Descripción
`action`	`string`	La acción que se realizó en el comentario. Puede ser `created`.
`pull_request`

          |
          `object` | [Solicitud de incorporación de cambios](/rest/pulls) a la que pertenece el comentario.

          `comment`
          |
          `object` | El propio [comentario](/rest/pulls#comments).

PushEvent

Se cargó una o más confirmaciones a la rama o etiqueta de un repositorio.

Objeto de evento `payload` para PushEvent

Key	Tipo	Description
`repository_id`	`integer`	Identificador único del repositorio donde ocurrió el push.
`push_id`	`integer`	Identificador único de la notificación.
`ref`	`string`	El elemento `git ref` completo que se ha insertado. Ejemplo: `refs/heads/main`.
`head`	`string`	El SHA de la confirmación más reciente en `ref` después de la inserción.
`before`	`string`	El SHA de la confirmación más reciente en `ref` antes de la inserción.

Evento de Lanzamiento

La actividad relacionada con un lanzamiento. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta la API REST de Puntos de conexión de la API REST para versiones y activos de lanzamiento.

Objeto de evento `payload` para ReleaseEvent

Clave	Tipo	Descripción
`action`	`string`	La acción que se ha realizado. Puede ser `published`.
`release`

          |
          `object` | Objeto [release](/rest/releases/releases#get-a-release).

WatchEvent

Cuando alguien marca un repositorio con una estrella. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, consulta Puntos de conexión de la API de REST para la actividad.

Objeto de evento `payload` para WatchEvent

Clave	Tipo	Descripción
`action`	`string`	La acción que se ha realizado. Actualmente, solo puede ser `started`.

En este artículo