Skip to main content

Types de webhook

Vous pouvez créer des webhooks pour vous abonner à des événements qui se produisent dans un référentiel ou une organisation spécifique, GitHub Enterprise, un compte GitHub Marketplace, un compte GitHub Sponsors, ou GitHub App.

À propos des types de webhooks

Un webhook peut uniquement accéder aux événements disponibles dans le référentiel, l'organisation, GitHub Enterprise,
le compte GitHub Marketplace, le compte GitHub Sponsors, ou GitHub App où il est installé.

Vous ne pouvez pas créer de webhooks pour des comptes d'utilisateur individuels, ou pour des événements spécifiques aux ressources utilisateur, telles que les notifications ou les mentions personnelles.

Pour créer et gérer les webhooks, vous devez posséder ou disposer d'un accès administrateur à la ressource sur laquelle le webhook est créé et écoute des événements. Par exemple, pour gérer les webhooks d'une organisation, vous avez besoin d'autorisations d'administrateur pour cette organisation.

Certains événements de webhook sont propres à certains types de webhooks. Par exemple, un webhook d'organisation peut s'abonner à des événements qui se produisent uniquement au niveau de l'organisation, auquel un webhook de référentiel ne peut pas s'abonner. Pour plus d'informations sur la disponibilité spécifique de chaque webhook, consultez « Événements et charges utiles du webhook ».

Pour plus d'informations, consultez « À propos des webhooks ».

Webhooks de dépôt

Vous pouvez créer un webhook dans un référentiel pour vous abonner aux événements qui se produisent dans celui-ci. Vous devez être propriétaire d'un référentiel ou disposer d'un accès administrateur au référentiel pour y créer et y gérer des webhooks. Vous ne pouvez pas créer, modifier ou supprimer des webhooks dans un référentiel où vous n'avez pas les autorisations requises.

Vous pouvez créer plusieurs webhooks dans un seul référentiel. Toutefois, vous pouvez uniquement créer jusqu'à 20 webhooks qui s'abonnent à chaque type d'événement individuel. Par exemple, dans un référentiel unique, vous pouvez uniquement créer jusqu'à 20 webhooks différents qui s'abonnent chacun à l'événement push.

Vous pouvez utiliser l'interface web GitHub ou l'API REST pour gérer des webhooks de référentiel. Pour plus d'informations, consultez « Création de webhooks », « Édition de webhooks » et « Désactivation des webhooks ». Pour plus d'informations sur l'utilisation de l'API REST dans la gestion des webhooks de référentiel consultez « Webhooks de dépôt ».

Webhooks d'organisation

Vous pouvez créer des webhooks dans une organisation pour vous abonner aux événements qui se produisent dans celle-ci. Les webhooks d'organisation peuvent s'abonner aux événements qui se produisent dans tous les référentiels appartenant à l'organisation. Ils peuvent également s'abonner à des événements qui se produisent au niveau de l'organisation et qui sont extérieurs à tout référentiel particulier, comme lorsqu'un nouveau membre est ajouté à l'organisation.

Vous devez être propriétaire d'une organisation pour créer et gérer des webhooks dans une organisation.

Vous pouvez créer plusieurs webhooks dans une seule organisation. Toutefois, vous pouvez uniquement créer jusqu'à 20 webhooks qui s'abonnent à chaque type d'événement individuel. Par exemple, dans une organisation unique, vous pouvez uniquement créer jusqu'à 20 webhooks différents qui s'abonnent chacun à l'événement push.

Vous pouvez utiliser l'interface web GitHub ou l'API REST pour gérer des webhooks d'organisation. Pour plus d'informations, consultez « Création de webhooks », « Édition de webhooks » et « Désactivation des webhooks ». Pour plus d'informations sur l'utilisation de l'API REST dans la gestion des webhooks d'organisation, consultez « Webhooks d’organisation ».

Webhooks globaux pour GitHub Enterprise

Les propriétaires d'entreprise peuvent créer des webhooks globaux pour s'abonner à des événements qui se produisent au sein de leur entreprise ou au sein d'organisations et de référentiels appartenant à l'entreprise.

Vous pouvez créer plusieurs webhooks dans une seule entreprise. Toutefois, vous pouvez uniquement créer jusqu'à 20 webhooks qui s'abonnent à chaque type d'événement individuel. Par exemple, dans une entreprise unique, vous pouvez uniquement créer jusqu'à 20 webhooks différents qui s'abonnent chacun à l'événement membership.

Vous pouvez utiliser l'interface web GitHub pour gérer des webhooks globaux. Pour plus d'informations, consultez « Création de webhooks », « Édition de webhooks » et « Désactivation des webhooks ».

Webhooks GitHub Marketplace

Vous pouvez créer un webhook pour vous abonner aux événements relatifs à une appli que vous avez publiée dans GitHub Marketplace. Vous ne pouvez créer qu'un webhook pour chaque application dans GitHub Marketplace. Seul le propriétaire de l'application, ou un gestionnaire d'application pour l'organisation propriétaire de l'application, peut créer et gérer un webhook GitHub Marketplace.

Un webhook GitHub Marketplace ne peut pas être supprimé, mais vous pouvez le désactiver pour arrêter de recevoir les livraisons du webhook.

Vous pouvez utiliser l'interface web GitHub pour gérer un webhook GitHub Marketplace. Pour plus d'informations, consultez « Création de webhooks », « Édition de webhooks » et « Désactivation des webhooks ».

Webhooks GitHub Sponsors

Vous pouvez créer des webhooks pour vous abonner aux événements relatifs à GitHub Sponsors. Vous pouvez uniquement créer jusqu'à 20 webhooks pour un compte GitHub Sponsors.

Vous devez être propriétaire du compte ou avoir un accès administrateur au compte parrainé pour gérer les webhooks de parrainage.

Vous pouvez utiliser l'interface web GitHub pour gérer les webhooks GitHub Sponsors. Pour plus d'informations, consultez « Création de webhooks », « Édition de webhooks » et « Désactivation des webhooks ».

Webhooks GitHub App

Vous pouvez configurer un GitHub App pour recevoir des webhooks lorsque des événements spécifiques se produisent dans une organisation ou un référentiel auquel l'application a été autorisée à accéder.

Chaque GitHub App a un webhook unique créé automatiquement par GitHub. Par défaut, le webhook n'est abonné à aucun événement. Vous pouvez configurer les événements auxquels le webhook s'abonne. Un webhook GitHub App ne peut pas être supprimé, mais vous pouvez le désactiver pour arrêter de recevoir les livraisons du webhook.

Vous pouvez utiliser l'interface web GitHub ou l'API REST pour gérer un webhook de GitHub App. Pour plus d'informations, consultez « Création de webhooks », « Édition de webhooks » et « Désactivation des webhooks ». Pour plus d'informations sur l'utilisation de l'API REST dans la gestion de webhooks GitHub App, consultez « Webhooks d’application GitHub ».