La API de eventos puede devolver diferentes tipos de ventos que se activan de acuerdo a 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 los eventos que se devuelven de las terminales de la API de Eventos tienen la misma estructura.
| Nombre del atributo de la API del Evento | Descripción |
|---|---|
id | Identificador único para el evento |
type | Tipo del evento. Los eventos utilizan PascalCase para el nombre. |
actor | El usuario que activó el evento. |
actor.id | El identificador único para el actor. |
actor.login | El nombre de usuario para el actor. |
actor.display_login | El formato de visualización específico para el nombre de usuario. |
actor.gravatar_id | El identificador único del perfil de Gravatar para el actor. |
actor.url | 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 | La URL de la imagen de perfil del actor. |
repo | El objeto del repositorio en donde ocurrió el evento. |
repo.id | El identificador único del repositorio. |
repo.name | El nombre del repositorio, el cual incluye también al nombre del propietario. Por ejemplo, octocat/hello-world es el nombre del repositorio hello-world que pertenece a la cuenta personal octocat. |
repo.url | 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 | El objeto de la carga útil del evento que es exclusivo para el tipo de evento. Vea el tipo de evento siguiente para el objeto de API payload. |
public | Si el evento es visible para todos los usuarios. |
created_at | La fecha y hora en que se desencadenó el evento. Tiene formato de conformidad con la ISO 8601. |
org | 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. |
org.id | El identificador único de la organización. |
org.login | El nombre de la organización. |
org.gravatar_id | El identificador único del perfil de Gravatar para la organización. |
org.url | La dirección URL de la API REST que se utiliza para recuperar el objeto de la organización, que incluye información adicional de esta organización. |
org.avatar_url | La dirección URL de la imagen de perfil de la organización. |
Ejemplo con el 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"
[
{
"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
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, vea la API REST de "confirmación de comentarios".
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 payload de evento
| 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, vea la API REST de "base de datos de Git".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
ref | string | Recurso git ref. |
ref_type | string | El tipo de objeto de Git ref que se creó en el repositorio. Puede ser branch o tag. |
master_branch | string | El nombre de la rama predeterminada del repositorio (a menudo main). |
description | string | La descripción actual del repositorio. |
DeleteEvent
Se borra una rama o etiqueta de Git. Para más información, vea la API REST de "base de datos de Git".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
ref | string | Recurso git ref. |
ref_type | string | El tipo de objeto de referencia de Git eliminado en el repositorio. Puede ser branch o tag. |
ForkEvent
Un usuario bifurca un repositorio. Para obtener más información, consulte las "bifurcaciones" de la API de REST.
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
forkee | object | Recurso repository creado. |
GollumEvent
Se crea o actualiza una página de wiki. Para más información, consulte "Acerca de las wikis".
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 payload de evento
| 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[][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, vea la API REST de "comentarios de incidencias".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se realizó en el comentario. Puede ser created, edited o deleted. changes |
changes[body][from] | string | Versión previa del cuerpo si la acción ha sido edited. |
issue | object | Problema al que pertenece el comentario. |
comment | object | El propio comentario. |
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, vea la API REST de "incidencias".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se ha realizado. Puede ser de tipo opened, edited, closed, reopened, assigned, unassigned, labeled o unlabeled. issue |
changes | object | Cambios en la incidencia si la acción ha sido edited. |
changes[title][from] | string | Versión previa del título si la acción ha sido edited. |
changes[body][from] | string | Versión previa del cuerpo si la acción ha sido edited. |
assignee | object | Usuario opcional que se ha asignado a la incidencia o se ha desasignado de ella. |
label | object | Etiqueta opcional que se ha agregado a la incidencia o se ha quitado de ella. |
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 la API REST de "colaboradores".
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 payload de evento
| 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 |
changes | object | Cambios en los permisos de colaborador si la acción ha sido edited. |
changes[old_permission][from] | string | Permisos anteriores del colaborador si la acción ha sido edited. |
PublicEvent
Cuando un repositorio privado se hace público. Sin duda alguna: el mejor evento de GitHub Enterprise Server.
Objeto payload de evento
Este evento devuelve un objeto payload vacío.
PullRequestEvent
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, vea la API REST de "solicitudes de incorporación de cambios".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se ha realizado. Puede ser opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled y synchronize. number |
changes | object | The changes to the comment if the action was edited. |
changes[title][from] | string | The previous version of the title if the action was edited. |
changes[body][from] | string | The previous version of the body if the action was edited. |
pull_request | object | The pull request itself. |
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 obtener más información, vea la API REST de "revisiones de solicitudes de incorporación de cambios".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se ha realizado. Puede ser created. |
pull_request | object | La solicitud de cambios a la cual pertenece la revisión. |
review | object | La revisión que se afectó. |
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 obtener más información, consulte la API de REST de "comentarios de revisiones de solicitudes de incorporación de cambios".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se realizó en el comentario. Puede ser created. changes |
changes[body][from] | string | Versión previa del cuerpo si la acción ha sido edited. |
pull_request | object | Solicitud de incorporación de cambios a la que pertenece el comentario. |
comment | object | El propio comentario. |
PullRequestReviewThreadEvent
Actividad relacionada con un hilo de comentarios en una solicitud de incorporación de cambios que se marca como resuelto o sin resolver. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga.
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se ha realizado. Puede ser una de las siguientes:
|
pull_request | object | La solicitud de incorporación de cambios a la que pertenece el subproceso. |
thread | object | El subproceso afectado. |
PushEvent
Se cargó una o más confirmaciones a la rama o etiqueta de un repositorio.
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
push_id | integer | Identificador único para la carga. |
size | integer | La cantidad de confirmaciones de la carga. |
distinct_size | integer | La cantidad de confimraciones distintas para la carga. |
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. |
commits | array | Un conjunto de objetos de confirmación que describen las confirmaciones subidas. (El conjunto incluye un máximo de 20 confirmaciones. Si es necesario, puede usar Commits API para capturar confirmaciones adicionales. Este límite se aplica a los eventos cronológicos únicamente y no se aplica a las entregas de webhooks). |
commits[][sha] | string | El SHA de la confirmación. |
commits[][message] | string | El mensaje de la confirmación. |
commits[][author] | object | El autor de git de la confirmación. |
commits[][author][name] | string | El nombre del autor de git. |
commits[][author][email] | string | La dirección de correo electrónico del autor de git. |
commits[][url] | url | URL que apunta al recurso de la API de la confirmación. |
commits[][distinct] | boolean | Si la confirmación es distinta de cualquier otra que se haya subido antes. |
ReleaseEvent
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, vea la API REST de "versiones".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se ha realizado. Puede ser published. changes[body][from] |
changes[name][from] | string | Versión anterior del nombre si la acción ha sido edited. |
release | object | Objeto 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, vea la API REST de "marcar con estrellas".
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 payload de evento
| Clave | Tipo | Descripción |
|---|---|---|
action | string | La acción que se ha realizado. Actualmente, solo puede ser started. |