Remarque : les webhooks GitHub ne prennent actuellement pas en charge IPv6, mais le feront à l’avenir. Le point de terminaison d’API REST /meta retourne des plages IPv6 pour permettre cette transition.
Les webhooks vous permettent de créer ou de configurer des intégrations, par exemple, des GitHub Apps ou des OAuth Apps, qui s’abonnent à certains événements sur GitHub.com. Quand un de ces événements est déclenché, nous envoyons une charge utile HTTP POST à l’URL configurée du webhook. Les webhooks peuvent être utilisés pour mettre à jour un utilitaire de suivi des problèmes externes, déclencher des builds CI, mettre à jour un miroir de sauvegarde ou même déployer sur votre serveur de production. Vous êtes limité seulement par votre imagination.
Les webhooks peuvent être installés sur GitHub Enterprise, une organisation, un dépôt spécifique ou une GitHub App. Une fois installé, le webhook est envoyé chaque fois qu’un ou plusieurs événements souscrits se produisent.
Vous pouvez créer jusqu’à 250 webhooks pour chaque événement sur chaque cible d’installation (instance GitHub Enterprise Server, organisation spécifique ou dépôt spécifique).
Événements
Lors de la configuration d’un webhook, vous pouvez choisir les événements qui vous envoient des charges utiles. Pour limiter le nombre de requêtes HTTP sur votre serveur, vous devez vous abonner uniquement aux événements spécifiques que vous prévoyez de gérer. Par défaut, les webhooks installés sur GitHub Enterprise, une organisation ou un dépôt sont uniquement abonnés à l’événement d’envoi. Par défaut, les webhooks sur une GitHub App ne sont abonnés à aucun événement. Vous pouvez modifier les événements auxquels un webhook est abonné à tout moment.
Chaque événement correspond à un certain ensemble d’actions qui peuvent se produire sur votre organisation et/ou dépôt. Par exemple, si vous vous abonnez à l’événement issues, vous recevez des charges utiles détaillées chaque fois qu’un problème est ouvert, fermé, étiqueté, etc.
Pour obtenir la liste complète des événements de webhook disponibles et leurs charges utiles, consultez « Événements et charges utiles du webhook ».
Événement ping
Lorsque vous créez un nouveau webhook, nous vous envoyons un simple événement ping pour vous informer que vous avez correctement configuré le webhook. Cet événement n’est pas stocké et ne peut donc pas être récupéré via le point de terminaison de l’API Événements.
Pour plus d’informations sur la charge utile de webhook d’événement ping, consultez l’événement ping.