Skip to main content

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.

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 EventoDescripción
idIdentificador único para el evento
typeTipo del evento. Los eventos utilizan PascalCase para el nombre.
actorEl 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, octocat/hello-world es el nombre del repositorio hello-world que pertenece a la cuenta personal octocat.
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. Vea el tipo de evento siguiente para el objeto de API payload.
publicSi el evento es visible para todos los usuarios.
created_atLa fecha y hora en que se desencadenó el evento. Tiene formato de conformidad con la ISO 8601.
orgLa 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.idEl identificador único de la organización.
org.loginEl nombre de la organización.
org.gravatar_idEl identificador único del perfil de Gravatar para la organización.
org.urlLa 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_urlLa 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

ClaveTipoDescripción
actionstringacción realizada. Puede ser created.
commentobjectRecurso 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

ClaveTipoDescripción
refstringRecurso git ref.
ref_typestringEl tipo de objeto de Git ref que se creó en el repositorio. Puede ser branch o tag.
master_branchstringEl nombre de la rama predeterminada del repositorio (a menudo main).
descriptionstringLa 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

ClaveTipoDescripción
refstringRecurso git ref.
ref_typestringEl 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

ClaveTipoDescripción
forkeeobjectRecurso 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

ClaveTipoDescripción
pagesarrayLas páginas que se actualizaron.
pages[][page_name]stringNombre de la página.
pages[][title]stringEl título de página actual.
pages[][action]stringLa acción que se realizó en la página. Puede ser created o edited.
pages[][sha]stringEl SHA de confirmación más reciente de la página.
pages[][html_url]stringApunta 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

ClaveTipoDescripción
actionstringLa acción que se realizó en el comentario. Puede ser created, edited o deleted. changes
changes[body][from]stringVersión previa del cuerpo si la acción ha sido edited.
issueobjectProblema al que pertenece el comentario.
commentobjectEl 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

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Puede ser de tipo opened, edited, closed, reopened, assigned, unassigned, labeled o unlabeled. issue
changesobjectCambios en la incidencia si la acción ha sido edited.
changes[title][from]stringVersión previa del título si la acción ha sido edited.
changes[body][from]stringVersión previa del cuerpo si la acción ha sido edited.
assigneeobjectUsuario opcional que se ha asignado a la incidencia o se ha desasignado de ella.
labelobjectEtiqueta 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

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Puede ser added para indicar que un usuario ha aceptado una invitación a un repositorio. member
changesobjectCambios en los permisos de colaborador si la acción ha sido edited.
changes[old_permission][from]stringPermisos 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 Cloud.

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

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Puede ser opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled y synchronize. number
changesobjectCambios en el comentario si la acción ha sido edited.
changes[title][from]stringVersión previa del título si la acción ha sido edited.
changes[body][from]stringVersión previa del cuerpo si la acción ha sido edited.
pull_requestobjectLa propia solicitud de incorporación de cambios.

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

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Puede ser created.
pull_requestobjectLa solicitud de cambios a la cual pertenece la revisión.
reviewobjectLa 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

ClaveTipoDescripción
actionstringLa acción que se realizó en el comentario. Puede ser created. changes
changes[body][from]stringVersión previa del cuerpo si la acción ha sido edited.
pull_requestobjectSolicitud de incorporación de cambios a la que pertenece el comentario.
commentobjectEl 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

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Puede ser una de las siguientes:
  • resolved: un subproceso de comentario en una solicitud de incorporación de cambios se ha marcado como resuelto.
  • unresolved: un subproceso de comentario resuelto previamente en una solicitud de incorporación de cambios se ha marcado como sin resolver.
pull_requestobjectLa solicitud de incorporación de cambios a la que pertenece el subproceso.
threadobjectEl 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

ClaveTipoDescripción
push_idintegerIdentificador único para la carga.
sizeintegerLa cantidad de confirmaciones de la carga.
distinct_sizeintegerLa cantidad de confimraciones distintas para la carga.
refstringEl elemento git ref completo que se ha insertado. Ejemplo: refs/heads/main.
headstringEl SHA de la confirmación más reciente en ref después de la inserción.
beforestringEl SHA de la confirmación más reciente en ref antes de la inserción.
commitsarrayUn 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]stringEl SHA de la confirmación.
commits[][message]stringEl mensaje de la confirmación.
commits[][author]objectEl autor de git de la confirmación.
commits[][author][name]stringEl nombre del autor de git.
commits[][author][email]stringLa 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 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

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Puede ser published. changes[body][from]
changes[name][from]stringVersión anterior del nombre si la acción ha sido edited.
releaseobjectObjeto release.

SponsorshipEvent

La actividad relacionada con un listado de patrocinio. El tipo de actividad se especifica en la propiedad action de la acción del objeto de carga. Para más información, vea "Acerca de los patrocinadores de GitHub".

Objeto payload de evento

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Puede ser created. effective_date
changes[tier][from]objectLos eventos tier_changed y pending_tier_change incluirán el nivel original antes del cambio o del cambio pendiente. Para obtener más información, consulte el ejemplo de la carga útil de cambio de nivel pendiente.
changes[privacy_level][from]stringLos tipos de eventos edited incluyen los detalles sobre el cambio cuando alguien edita un patrocinio para cambiar la privacidad.

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

ClaveTipoDescripción
actionstringLa acción que se ha realizado. Actualmente, solo puede ser started.