Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

Esta versión de GitHub Enterprise se discontinuará el Esta versión de GitHub Enterprise se discontinuó el 2020-11-12. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener un mejor desempeño, más seguridad y nuevas características, actualiza a la última versión de GitHub Enterprise. Para obtener ayuda con la actualización, contacta al soporte de GitHub Enterprise.

Tipos de evento de GitHub

Para la API de Eventos de GitHub, aprende acerca de cada tipo de evento, la acción que los desencadena en GitHub, y las propiedades exclusivas de cada evento.

Las cuentas empresariales se encuentran disponibles con GitHub Enterprise Cloud y Servidor de GitHub Enterprise.

En este artículo

¿Te ayudó este documento?

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

O, learn how to contribute.

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 EventoDescripción
idIdentificador único para el evento.
typeEl tipo de evento. Los eventos utilizan PascalCase para el nombre.
actor (actor)El usuario que activó el evento.
actor.idEl identificador único para el actor.
actor.loginEl nombre de usuario para el actor.
actor.display_loginEl formato de visualización específico para el nombre de usuario.
actor.gravatar_idEl identificador único del perfil de Gravatar para el actor.
actor.urlLa 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_urlLa URL de la imagen de perfil del actor.
repoEl objeto del repositorio en donde ocurrió el evento.
repo.idEl identificador único del repositorio.
repo.nameEl 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.urlLa URL de la API de REST que se utiliza para recuperar el objeto del repositorio, el cual incluye información adicional sobre dicho repositorio.
payloadEl 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.

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

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

ClaveTipoDescripción
AcciónsecuenciaLa acción realizada. Puede ser created.
comentarioobjetoEl 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 "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

ClaveTipoDescripción
refsecuenciaEl recurso git ref.
ref_typesecuenciaEl tipo de objeto de Git ref que se creó en el repositorio. Puede ser branch o tag.
master_branchsecuenciaEl nombre dela rama predeterminada del repositorio (a menudo master).
descripciónsecuenciaLa 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 "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

ClaveTipoDescripción
refsecuenciaEl recurso git ref.
ref_typesecuenciaEl 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

ClaveTipoDescripción
forkeeobjetoEl 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 las 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

ClaveTipoDescripción
páginasarrayLas páginas que se actualizaron.
pages[][page_name]secuenciaEl nombre de la página.
pages[][title]secuenciaEl título de la página actual.
pages[][action]secuenciaLa acción que se realizó en la página. Puede ser created o edited.
pages[][sha]secuenciaEl SHA de confirmación más reciente de la página.
pages[][html_url]secuenciaApunta a la página de wiki de HMTL.

IssueCommentEvent

La actividad relacionada con el comentario de 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 "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

ClaveTipoDescripción
AcciónsecuenciaLa acción que se realizó en el comentario. Puede ser created, edited, o deleted.
changesobjectLos 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

ClaveTipoDescripción
AcciónsecuenciaLa acción que se realizó. Puede ser una de entre opened, closed, reopened, assigned, unassigned, labeled, o unlabeled.
issueobjectEl 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

ClaveTipoDescripción
AcciónsecuenciaLa acción que se realizó. Puede ponerse como added para indicar que un usuario aceptó una invitación al repositorio.
memberobjectEl user que se agregó. changes

PublicEvent

Cuando un repositorio privado se hace público. Sin duda alguna: el mejor evento de GitHub Enterprise.

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

ClaveTipoDescripción
AcciónsecuenciaLa acción que se realizó. Puede ser una de entre opened, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled, y synchronize.
numberintegerEl número de la solicitud de extracción. changes

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

ClaveTipoDescripción
AcciónsecuenciaLa acción que se realizó en el comentario. Puede ser created.
changesobjectLos 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.

ClaveTipoDescripción
push_idnúmeroIdentificador único para la carga.
tamañonúmeroLa cantidad de confirmaciones de la carga.
distinct_sizenúmeroLa cantidad de confimraciones distintas para la carga.
refsecuenciaToda la git ref que se cargó. Ejemplo: refs/heads/master.
encabezadosecuenciaEl SHA de la confirmación más reciente en ref después de la carga.
beforesecuenciaEl SHA de la confirmación más reciente en ref antes de la carga.
commitsarrayUn 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]secuenciaEl SHA de la confirmación.
commits[][message]secuenciaEl mensaje de la confirmación.
commits[][author]objetoEl autor de git de la confirmación.
commits[][author][name]secuenciaEl nombre del autor de git.
commits[][author][email]secuenciaLa dirección de correo electrónico del autor de git.
commits[][url]urlURL que apunta al recurso de la API de la confirmación.
commits[][distinct]booleanSi 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

ClaveTipoDescripción
AcciónsecuenciaLa acción que se realizó. Puede ponerse como published.
changes[body][from]stringLa 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

ClaveTipoDescripción
AcciónsecuenciaLa acción que se realizó. Acutalmente, solo puede ser started.

¿Te ayudó este documento?

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

O, learn how to contribute.