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 único de payload que se determina por su tipo de evento. Las propiedades comunes del objeto de los eventos describen aquellas propiedades que comparten todos los eventos, y cada tipo de evento describe las propiedades de la payload que son exclusivas para éste.
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 | El tipo de evento. Los eventos utilizan PascalCase para el nombre. |
actor (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, el nombre del repositorio hello-world, cuyo propietario es la cuenta de usuario octocat, es octocat/hello-world. |
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. En el siguiente ejemplo puedes ver el tipo de evento para el objeto de payload de la API de eventos. |
Ejemplo con el objeto de evento WatchEvent
Este ejemplo te muestra el formato de la respuesta de WatchEvent cuando utilizas la 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
Se creó un comentario de una confirmación. El tipo de actividad se especifica en la propiedad action del objeto de la carga útil. Para obtener más información, consulta la API de REST de "comentario de confirmación".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción realizada. Puede ser created. |
comentario | objeto | El recurso de comentario de la confirmación. |
CreateEvent
Se crea una rama o etiqueta de Git. Para obtener más información, consulta la API de REST de "Git database".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
ref | secuencia | El recurso de la git ref. |
ref_type | secuencia | El tipo de objeto de Git ref que se creó en el repositorio. Puede ser branch o tag. |
master_branch | secuencia | El nombre de la rama predeterminada del repositorio (habitualmente master). |
descripción | secuencia | La descripción actual del repositorio. |
DeleteEvent
Se borra una rama o etiqueta de Git. Para obtener más información, consulta la API de REST de "Base de datos de Git".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
ref | secuencia | El recurso de la git ref. |
ref_type | secuencia | El tipo de objeto de Git ref que se borró en el repositorio. Puede ser branch o tag. |
ForkEvent
Un usuario bifurca un repositorio. Para obtener más información, consulta la API de REST de "bifurcaciones".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
forkee | objeto | El recurso de repository que se creó. |
GollumEvent
Se crea o actualiza una página de wiki. Para obtener más información, consulta la sección "Acerca de los wikis".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
páginas | arreglo | Las páginas que se actualizaron. |
pages[][page_name] | secuencia | El nombre de la página. |
pages[][title] | secuencia | El título de la página actual. |
pages[][action] | secuencia | La acción que se realizó en la página. Puede ser created o edited. |
pages[][sha] | secuencia | El SHA de confirmación más reciente de la página. |
pages[][html_url] | secuencia | 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 del objeto de la carga útil. Para obtener más información, consulta la API de REST de "comentrios del informe de problemas".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó en el comentario. Puede ser created, edited, o deleted. |
changes | object | Los cambios al comentario en caso de que la acción sea edited. changes[body][from] |
IssuesEvent
La actividar relacionada con un informe de problemas. El tipo de actividad se especifica en la propiedad action del objeto de la carga útil. Para obtener más información, consulta la API de REST de "informe de problemas".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó. Puede ser uno de entre opened, edited, closed, reopened, assigned, unassigned, labeled o unlabeled. |
issue | object | El issue mismo. changes |
MemberEvent
La actividad relacionada con los colaboradores del repositorio. El tipo de actividad se especifica en la propiedad action del objeto de la carga útil. Para obtener más información, consulta la API de REST de "colaboradores".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó. Puede ponerse como added para indicar que un usuario aceptó una invitación al repositorio. |
member | object | El user que se agregó. changes |
PublicEvent
Cuando un repositorio privado se hace público. Sin duda alguna: el mejor evento de GitHub Enterprise Server.
Objeto de payload del evento
Este evento devuelve un objeto de payload vacío.
PullRequestEvent
La actividad relacionada con las solicitudes de extracción. El tipo de actividad se especifica en la propiedad action del objeto de la carga útil. Para obtener más información, consulta la API de REST de "solicitudes de extracción".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó. Puede ser uno de entre opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled y synchronize. |
number | integer | El número de la solicitud de extracción. changes |
PullRequestReviewEvent
La actividad relacionada con las revisiones de la solicitudes de extracción. El tipo de actividad se especifica en la propiedad action del objeto de la carga útil. Para obtener más información, consulta la API de REST de "revisiones de la solicitud de extracción".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó. Puede ser created. |
solicitud_extracción | objeto | La solicitud de cambios a la cual pertenece la revisión. |
revisar | objeto | 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 del objeto de la carga útil. Para obtener más información, consulta la API de REST de "comentrios de revisión de la solicitud de extracción".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó en el comentario. Puede ser created. |
changes | object | Los cambios al comentario en caso de que la acción sea edited. changes[body][from] |
PushEvent
Se cargó una o más confirmaciones a la rama o etiqueta de un repositorio.
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
push_id | número | Identificador único para la carga. |
tamaño | número | La cantidad de confirmaciones de la carga. |
distinct_size | número | La cantidad de confimraciones distintas para la carga. |
ref | secuencia | Toda la git ref que se cargó. Ejemplo: refs/heads/main. |
encabezado | secuencia | El SHA de la confirmación más reciente en ref después de la carga. |
before | secuencia | El SHA de la confirmación más reciente en ref antes de la carga. |
commits | arreglo | Un conjunto de objetos de confirmación que describen las confirmaciones subidas. (El conjunto incluye un máximo de 20 confirmaciones. De ser encesario, puedes utilizar la API de confirmaciones para recuperar confirmaciones adicionales. Este límite se aplica a los eventos cronológicos únicamente y no se aplica a las entregas de webhooks). |
commits[][sha] | secuencia | El SHA de la confirmación. |
commits[][message] | secuencia | El mensaje de la confirmación. |
commits[][author] | objeto | El autor de git de la confirmación. |
commits[][author][name] | secuencia | El nombre del autor de git. |
commits[][author][email] | secuencia | 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 del objeto de la carga útil. Para obtener más información, consulta la API de REST de "lanzamientos".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó. Puede ponerse como published. |
changes[body][from] | string | La versión previa del cuerpo si la acción aparece como edited. changes[name][from] |
WatchEvent
Cuando alguien marca un repositorio con una estrella. El tipo de actividad se especifica en la propiedad action del objeto de la carga útil. Para obtener más información, consulta la API de REST de "marcar con una estrella".
El objeto del evento incluye propiedades que son comunes para todos los eventos. Cada objeto de evento incluye una propiedad de payload y el valor es único para cada tipo de evento. El objeto de payload para este evento se describe a continuación.
Objeto de payload del evento
| Clave | Tipo | Descripción |
|---|---|---|
Acción | secuencia | La acción que se realizó. Acutalmente, solo puede ser started. |