Skip to main content

Types d’événements GitHub

Pour les API Événements GitHub, découvrez chaque type d’événement, l’action de déclenchement sur GitHub et les propriétés uniques de chaque événement.

L’API Événements peut retourner différents types d’événements déclenchés par l’activité sur GitHub. Chaque réponse d’événement contient des propriétés partagées, mais a un objet payload unique déterminé par son type d’événement. Les Propriétés communes des objets d’événement décrivent les propriétés partagées par tous les événements, et chaque type d’événement décrit les propriétés de payload propres à l’événement spécifique.

Propriétés courantes des objets d’événement

Les objets d’événement retournés par les points de terminaison de l’API Événements ont la même structure.

Nom de l’attribut d’API d’événementTypeDescription
idstringIdentificateur unique de l’événement.
typestringType de l'événement. Les événements utilisent la casse Pascal pour le nom.
actorobjectUtilisateur qui a déclenché l’événement.
actor.idstringIdentificateur unique de l’acteur.
actor.loginstringNom d’utilisateur de l’acteur.
actor.display_loginstringFormat d’affichage spécifique du nom d’utilisateur.
actor.gravatar_idstringIdentificateur unique du profil Gravatar de l’acteur.
actor.urlstringURL de l’API REST utilisée pour récupérer l’objet utilisateur, qui comprend des informations supplémentaires sur l’utilisateur.
actor.avatar_urlstringURL de l’image de profil de l’acteur.
repositoryobjectObjet de dépôt où l’événement s’est produit.
repository.idstringIdentificateur unique du dépôt.
repository.namestringNom du dépôt, qui comprend le nom du propriétaire et du dépôt. Par exemple, octocat/hello-world est le nom du dépôt hello-world appartenant au compte personnel octocat.
repository.urlstringURL de l’API REST utilisée pour récupérer l’objet de dépôt, qui comprend des informations supplémentaires sur le dépôt.
payloadobjectL’objet de charge utile d’événement est propre au type d’événement. Consultez le type d’événement ci-dessous pour l’objet payload de l’API d’événement.
publicbooleanIndique si l’événement est visible pour tous les utilisateurs.
created_atstringLa date et l’heure de déclenchement de l’événement. Il est mis en forme conformément à la norme ISO 8601.
orgobjectL’organisation choisie par l’acteur pour effectuer une action qui déclenche l’événement.
La propriété apparaît dans l’objet d’événement uniquement s’il est applicable.
org.idstringIdentificateur unique de l’organisation.
org.loginstringNom de l’organisation.
org.gravatar_idstringIdentificateur unique du profil Gravatar de l’organisation.
org.urlstringL’URL de l’API REST utilisée pour récupérer l’objet de l’organisation, qui comprend des informations supplémentaires sur l’organisation.
org.avatar_urlstringL’URL de l’image de profil de l’organisation.

Exemple d’objet d’événement WatchEvent

Cet exemple montre le format de la réponse WatchEvent en cas d’utilisation de l’API Événements.

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": {
    },
    "repository": {
      "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

Un commentaire de commit est créé. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Commentaires de commit ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour CommitCommentEvent

CléTypeDescription
actionstringaction effectuée. Peut être created.
commentobjectRessource commentaire de validation.

CreateEvent

Une branche ou une étiquette Git est créée. Pour plus d’informations, consultez l’API REST « Base de données Git ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour CreateEvent

CléTypeDescription
refstringRessource git ref, ou null si ref_type est repository.
ref_typestringType d’objet de référence Git créé dans le référentiel. Il peut être branch, tag ou repository.
master_branchstringNom de la branche par défaut du référentiel (généralement main).
descriptionstringDescription actuelle du référentiel.
pusher_typestringPeut être user ou une clé de déploiement.

DeleteEvent

Une branche ou une étiquette Git est supprimée. Pour plus d’informations, consultez l’API REST « Base de données Git ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour DeleteEvent

CléTypeDescription
refstringRessource git ref.
ref_typestringType d’objet de référence Git supprimé dans le référentiel. La valeur peut être branch ou tag.

ForkEvent

Un utilisateur duplique un dépôt. Pour plus d’informations, consultez l’API REST « Référentiels ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour ForkEvent

CléTypeDescription
forkeeobjectRessource repository créée.

GollumEvent

Une page wiki est créée ou mise à jour. Pour plus d’informations, consultez « À propos des wikis ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour GollumEvent

CléTypeDescription
pagesarrayPages qui ont été mises à jour.
pages[][page_name]stringNom de la page.
pages[][title]stringTitre de la page.
pages[][action]stringAction qui a été effectuée dans la page Peut être created ou edited.
pages[][sha]stringAlgorithme SHA de commit le plus récent de la page.
pages[][html_url]stringPointe vers la page wiki HTML.

IssueCommentEvent

Activité liée à un problème ou à un commentaire de demande de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Problèmes ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour IssueCommentEvent

CléTypeDescription
actionstringAction effectuée sur le commentaire. Peut être created, edited ou deleted.
changesobjectModifications apportées au commentaire si l’action était edited.
changes[body][from]stringVersion précédente du corps si l’action était edited.
issueobjectProblème auquel appartient le commentaire.
commentobjectLe commentaire proprement dit.

IssuesEvent

Activité liée à un problème. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Problèmes ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour IssuesEvent

CléTypeDescription
actionstringAction qui a été effectuée. Il peut s’agir de opened, edited, closed, reopened, assigned, unassigned, labeled ou unlabeled.
issueobjectLe problème lui-même.
changesobjectChangements dans le problème si l’action est edited.
changes[title][from]stringVersion précédente du titre si l’action est edited.
changes[body][from]stringVersion précédente du corps si l’action est edited.
assigneeobjectUtilisateur facultatif à qui le problème a été attribué ou désattribué.
labelobjectÉtiquette facultative qui a été ajoutée ou supprimée du problème.

MemberEvent

Activité liée aux collaborateurs du référentiel. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Collaborateurs ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour MemberEvent

CléTypeDescription
actionstringAction qui a été effectuée. Peut être added pour indiquer qu’un utilisateur a accepté une invitation à un dépôt.
memberobjectUtilisateur ajouté.
changesobjectModifications apportées aux autorisations de collaborateur si l’action était edited.
changes[old_permission][from]stringAutorisations précédentes du collaborateur si l’action était edited.

PublicEvent

Quand un dépôt privé est rendu public. Sans aucun doute : le meilleur événement GitHub.

Objet payload d’événement pour PublicEvent

Cet événement retourne un objet payload vide.

PullRequestEvent

Activité liée aux demandes de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Tirages ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour PullRequestEvent

CléTypeDescription
actionstringAction qui a été effectuée. Peut être opened, edited, closed, reopened, assigned, unassigned, review_requested, review_request_removed, labeled, unlabeled ou synchronize.
numberintegerNuméro de la demande de tirage.
changesobjectChangements dans le commentaire si l’action est edited.
changes[title][from]stringVersion précédente du titre si l’action est edited.
changes[body][from]stringVersion précédente du corps si l’action est edited.
pull_requestobjectLa demande de tirage elle-même.
reasonstringLa raison pour laquelle la demande de tirage a été supprimée d’une file d’attente de fusion si l’action était dequeued.

PullRequestReviewEvent

Activité liée aux révisions de demande de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Tirages ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour PullRequestReviewEvent

CléTypeDescription
actionstringAction qui a été effectuée. Peut être created.
pull_requestobjectDemande de tirage à laquelle appartient la révision.
reviewobjectRévision qui a été affectée.

PullRequestReviewCommentEvent

Activité liée aux commentaires de révision des demandes de tirage dans la différence unifiée de la demande de tirage. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Tirages ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour PullRequestReviewCommentEvent

CléTypeDescription
actionstringAction effectuée sur le commentaire. Peut être created.
changesobjectChangements dans le commentaire si l’action est edited.
changes[body][from]stringVersion précédente du corps si l’action est edited.
pull_requestobjectDemande de tirage à laquelle appartient le commentaire.
commentobjectLe commentaire lui-même.

PullRequestReviewThreadEvent

Activité liée à un thread de commentaire sur une demande de tirage marquée comme résolue ou non résolue. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile.

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour PullRequestReviewThreadEvent

CléTypeDescription
actionstringAction qui a été effectuée. Peut être :
  • resolved - Un fil de commentaires sur une demande de tirage a été marqué comme résolu.
  • unresolved - Un fil de commentaires précédemment résolu sur une demande de tirage a été marqué comme non résolu.
pull_requestobjectLa demande de tirage à laquelle se rapporte le thread.
threadobjectLe fil affecté.

PushEvent

Un ou plusieurs commits sont poussés sur une branche ou une étiquette de dépôt.

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour PushEvent

CléTypeDescription
push_idintegerIdentificateur unique pour la poussée.
sizeintegerNombre de commits dans la poussée.
distinct_sizeintegerNombre de commits distincts dans la poussée.
refstringLa git ref complète qui a été poussée. Exemple : refs/heads/main.
headstringSHA du commit le plus récent sur ref après la poussée.
beforestringSHA du commit le plus récent sur ref avant la poussée.
commitsarrayTableau d’objets de commit décrivant les commits poussés. (Le tableau comprend un maximum de 20 commits. Si nécessaire, vous pouvez utiliser l’API Commits pour récupérer des commits supplémentaires. Cette limite s’applique uniquement aux événements de chronologie et non aux livraisons de webhook.)
commits[][sha]stringSHA du commit.
commits[][message]stringMessage du commit.
commits[][author]objectAuteur Git du commit.
commits[][author][name]stringNom de l’auteur Git.
commits[][author][email]stringAdresse e-mail de l’auteur Git.
commits[][url]urlURL qui pointe vers la ressource d’API de commit.
commits[][distinct]booleanIndique si ce commit est distinct de ceux qui ont été poussés précédemment.

ReleaseEvent

Activité liée à une version. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Publications ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour ReleaseEvent

CléTypeDescription
actionstringAction qui a été effectuée. Peut être published.
changes[body][from]stringVersion précédente du corps si l’action était edited.
changes[name][from]stringVersion précédente du nom si l’action était edited.
releaseobjectObjet release.

SponsorshipEvent

Activité liée à une liste de sponsorship. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez « À propos de GitHub Sponsors ».

Objet payload d’événement pour SponsorshipEvent

CléTypeDescription
actionstringAction qui a été effectuée. Il peut s’agir de created.
effective_datestringLes types d’événements pending_cancellation et pending_tier_change incluent la date à laquelle l’annulation ou le changement de niveau prend effet.
changes[tier][from]objecttier_changed et pending_tier_change incluent le niveau d’origine avant le changement ou le changement en attente. Pour plus d’informations, consultez la charge utile du changement de niveau en attente.
changes[privacy_level][from]stringLes types d’événements edited incluent les détails du changement lorsque quelqu’un modifie un parrainage pour changer la confidentialité.

WatchEvent

Quand une personne met une étoile à un dépôt. Le type d’activité est spécifié dans la propriété action de l’objet de charge utile. Pour plus d’informations, consultez l’API REST « Activité ».

L’objet d’événement comprend des propriétés communes à tous les événements. Chaque objet d’événement a une propriété payload et la valeur est unique pour chaque type d’événement. L’objet payload de cet événement est décrit ci-dessous.

Objet payload d’événement pour WatchEvent

CléTypeDescription
actionstringAction qui a été effectuée. Actuellement, peut être seulement started.