Publicamos actualizaciones para la documentación con frecuencia y es posible que aún se esté traduciendo esta página. Para obtener la información más reciente, visite la documentación en inglés.
For the Issues Events API and Timeline API, learn about each event type, the triggering action on GitHub, and each event's unique properties.
Issue events are triggered by activity in issues and pull requests and are available in the Issue Events API and the Timeline Events API. Each event type specifies whether the event is available in the Issue Events or Timeline Events APIs.
GitHub's REST API considers every pull request to be an issue, but not every issue is a pull request. For this reason, the Issue Events and Timeline Events endpoints may return both issues and pull requests in the response. Pull requests have a pull_request property in the issue object. Because pull requests are issues, issue and pull request numbers do not overlap in a repository. For example, if you open your first issue in a repository, the number will be 1. If you then open a pull request, the number will be 2. Each event type specifies if the event occurs in pull request, issues, or both.
Issue event object common properties
Issue events all have the same object structure, except events that are only available in the Timeline Events API. Some events also include additional properties that provide more context about the event resources. Refer to the specific event to for details about any properties that differ from this object format.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
added_to_project
The issue or pull request was added to a project board. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Availability
Issue type
Issue events API
Timeline events API
Issues
Pull request
X
X
Event object properties
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a el administrador del sitio.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
closed
The issue or pull request was closed. When the commit_id is present, it identifies the commit that closed the issue using "closes / fixes" syntax. For more information about the syntax, see "Linking a pull request to an issue".
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
converted_note_to_issue
The issue was created by converting a note in a project board to an issue. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Availability
Issue type
Issue events API
Timeline events API
Issues
X
X
Event object properties
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a el administrador del sitio.
The timestamp indicating when the cross-reference was added.
updated_at
string
The timestamp indicating when the cross-reference was updated or created, if the cross-reference is never updated.
source
object
The issue or pull request that added a cross-reference.
source[type]
string
This value will always be "issue" because pull requests are of type issue. Only cross-reference events triggered by issues or pull requests are returned in the Timeline Events API. To determine if the issue that triggered the event is a pull request, you can check if the source[issue][pull_request] object exists.
source[issue]
object
The issue object that added the cross-reference.
event
string
The event value is "cross-referenced".
demilestoned
The issue or pull request was removed from a milestone.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
merged
The pull request was merged. The commit_id attribute is the SHA1 of the HEAD commit that was merged. The commit_repository is always the same as the main repository.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
milestone
object
The milestone object.
milestone[title]
string
The title of the milestone.
moved_columns_in_project
The issue or pull request was moved between columns in a project board. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Availability
Issue type
Issue events API
Timeline events API
Issues
Pull requests
X
X
Event object properties
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a el administrador del sitio.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
referenced
The issue was referenced from a commit message. The commit_id attribute is the commit SHA1 of where that happened and the commit_repository is where that commit was pushed.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
removed_from_project
The issue or pull request was removed from a project board. Solo verá este evento en las respuestas cuando los paneles de proyecto se han habilitado en el repositorio.
Availability
Issue type
Issue events API
Timeline events API
Issues
Pull requests
X
X
Event object properties
Nota: Los detalles de la tarjeta del proyecto ahora se muestran en las respuestas de la API REST para los eventos de incidencias y escala de tiempo relacionados con el proyecto. Esta característica está ahora disponible para que los desarrolladores la previsualicen. Para más información, vea esta entrada de blog.
Para recibir el atributo project_card, los paneles de proyecto deben estar habilitados para un repositorio y debe proporcionar un tipo de medio personalizado en el encabezado Accept:
application/vnd.github.starfox-preview+json
Advertencia: La API podría cambiar sin previo aviso durante el periodo de versión preliminar. Las características de la vista previa no son compatibles con un uso productivo. Si experimentas cualquier problema, contacta a el administrador del sitio.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
dismissed_review
object
Información de la revisión descartada.
dismissed_review[state]
string
Estado en el que se encontraba la solicitud de incorporación de cambios cuando se ha descartado. Puede ser de tipo commented, approved o changes_requested.
dismissed_review[review_id]
string
Identificador único de la revisión de la solicitud de incorporación de cambios.
dismissed_review[dismissal_message]
string
Mensaje que el usuario ha incluido al descartar la revisión.
dismissed_review[dismissal_commit_id]
string
Identificador único de la confirmación que ha descartado la revisión, si existe.
La URL de la API de REST para recuperar el evento.
actor
object
La persona que generó el evento.
event
string
Identifica el tipo de evento real que ocurrió.
commit_id
string
EL SHA de la confirmación que referenció este informe de problemas.
commit_url
string
El enlace a la API de REST de GitHub para la confirmación que referenció a este informe de problemas.
created_at
string
La marca de tiempo que indica cuándo ocurrió el evento.
lock_reason
string
The reason an issue or pull request conversation was locked, if one was provided.
unmarked_as_duplicate
An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.