Création de webhooks

A propos de la création de webhooks

Vous pouvez créer des webhooks afin de vous abonner à des événements spécifiques sur GitHub se produisant dans un référentiel, une organisation, GitHub Enterprise, GitHub Marketplace compte, GitHub Sponsors compte, ou GitHub App

Pour en savoir plus sur les différents types de webhooks, consultez « Types de webhook».

Pour obtenir la liste complète des événements de webhook, consultez « Événements et charges utiles du webhook ».

Création d'un webhook de référentiel

Vous pouvez créer un webhook pour vous abonner aux événements qui se produisent dans un référentiel spécifique. Vous devez être propriétaire d'un référentiel ou disposer d'un accès administrateur au référentiel pour créer des webhooks dans ce référentiel.

Vous pouvez utiliser l'interface web GitHub ou l'API REST pour créer un webhook de dépôt. Pour en savoir plus sur l'utilisation de l'API REST pour créer un webhook de référentiel, consultez « Points de terminaison d’API REST pour les webhooks du référentiel ».

1. Sur GitHub, accédez à la page principale du référentiel.

2. Sous le nom de votre référentiel, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

3. Dans la barre latérale gauche, cliquez sur Webhooks.

4. Cliquez sur Ajouter un webhook.

5. Sous « URL de charge utile », saisissez l'URL où vous souhaitez recevoir les charges utiles.

6. Si vous le souhaitez, sélectionnez le menu déroulant Type de contenu et cliquez sur un format de données dans lequel recevoir la charge utile du webhook.

   • application/json transmettra la charge utile JSON directement dans le corps de la demande POST.
   • application/x-www-form-urlencoded enverra la charge utile JSON en tant que paramètre de formulaire appelé payload.

7. En option, sous « Secret », saisissez une chaîne de caractères à utiliser comme clé secret. Vous devez choisir une chaîne aléatoire de texte avec une entropie élevée. Vous pouvez utiliser le secret du webhook pour limiter les demandes entrantes à celles provenant de GitHub uniquement. Pour plus d’informations, consultez « Validation des livraisons de webhook ».

8. Sous « Quels sont les événements qui doivent déclencher ce webhook ? », sélectionnez les événements du webhook que vous souhaitez recevoir. Abonnez-vous uniquement aux événements de webhook dont vous avez besoin.

9. Si vous avez choisi de me laisser sélectionner des événements individuels, sélectionnez les événements qui doivent déclencher le webhook.

10. Pour rendre le webhook actif immédiatement après l'ajout de la configuration, sélectionnez Actif.

11. Cliquez sur Ajouter un webhook.

Après avoir créé un nouveau webhook, GitHub vous enverra un simple événement ping pour vous indiquer que vous avez correctement configuré le webhook. Pour plus d’informations, consultez « Événements et charges utiles du webhook ».

Création d'un webhook pour organisation

Vous pouvez créer un webhook pour vous abonner aux événements qui se produisent dans une organisation spécifique. Vous devez être propriétaire d'une organisation pour créer des webhooks dans cette organisation.

Vous pouvez utiliser l'interface web GitHub ou l'API REST pour créer un webhook d'organisation. Pour en savoir plus sur l'utilisation de l'API REST pour créer un webhook d'organisation, consultez « Points de terminaison d’API REST pour les webhooks de l'organisation ».

1. Dans le coin supérieur droit de n’importe quelle page sur GitHub, cliquez sur votre photo de profil.
2. Cliquez sur Vos organisations.
3. À droite de l'organisation, cliquez sur Paramètres.
4. Dans la barre latérale gauche, cliquez sur Webhooks.
5. Cliquez sur Ajouter un webhook.
6. Sous « URL de charge utile », saisissez l'URL où vous souhaitez recevoir les charges utiles.
7. Si vous le souhaitez, sélectionnez le menu déroulant Type de contenu et cliquez sur un format de données dans lequel recevoir la charge utile du webhook.
   • application/json transmettra la charge utile JSON directement dans le corps de la demande POST.
   • application/x-www-form-urlencoded enverra la charge utile JSON en tant que paramètre de formulaire appelé payload.
8. En option, sous « Secret », saisissez une chaîne de caractères à utiliser comme clé secret. Vous devez choisir une chaîne aléatoire de texte avec une entropie élevée. Vous pouvez utiliser le secret du webhook pour limiter les demandes entrantes à celles provenant de GitHub uniquement. Pour plus d’informations, consultez « Validation des livraisons de webhook ».
9. Sous « Quels sont les événements qui doivent déclencher ce webhook ? », sélectionnez les types de webhooks que vous souhaitez recevoir. Abonnez-vous uniquement aux événements de webhook dont vous avez besoin.
10. Si vous avez choisi de me laisser sélectionner des événements individuels, sélectionnez les événements qui déclencheront le webhook.
11. Pour rendre le webhook actif immédiatement après l'ajout de la configuration, sélectionnez Actif.
12. Cliquez sur Ajouter un webhook.

Après avoir créé un nouveau webhook, GitHub vous enverra un simple événement ping pour vous indiquer que vous avez correctement configuré le webhook. Pour plus d’informations, consultez « Événements et charges utiles du webhook ».

Création d'un webhook global pour un GitHub Enterprise

Les propriétaires d'entreprise peuvent créer un webhook global pour s'abonner à des événements qui se produisent au sein de leur entreprise.

1. Accédez à votre entreprise. Par exemple, depuis la page Entreprises sur GitHub.com.

2. En haut de la page, cliquez sur Paramètres.

3. Sous " Paramètres", cliquez sur Hooks.

4. Cliquez sur Ajouter un webhook.

5. Dans le champ « URL de la charge utile », tapez l'URL où vous souhaitez recevoir les charges utiles.

6. Si vous le souhaitez, sélectionnez le menu déroulant Type de contenu et cliquez sur un format de données dans lequel recevoir la charge utile du webhook.

   • application/json transmettra la charge utile JSON directement dans le corps de la demande POST.
   • application/x-www-form-urlencoded enverra la charge utile JSON en tant que paramètre de formulaire appelé payload.

7. En option, sous « Secret », saisissez une chaîne de caractères à utiliser comme clé secret. Vous devez choisir une chaîne aléatoire de texte avec une entropie élevée. Vous pouvez utiliser le secret du webhook pour limiter les demandes entrantes à celles provenant de GitHub uniquement. Pour plus d’informations, consultez « Validation des livraisons de webhook ».

8. Si votre URL de charge utile est une URL HTTPS et que vous ne voulez pas que GitHub Enterprise Server vérifie les certificats SSL à la remise de charges utiles, sous « Vérification SSL », sélectionnez Désactiver. Lisez les informations relatives à la vérification SSL, puis cliquez sur Désactiver, je comprends que mes webhooks ne sont peut-être pas sécurisés.

   Avertissement

   La vérification SSL aide à garantir que les charges utiles des webhooks sont livrées en toute sécurité. Nous vous déconseillons de désactiver la vérification SSL.

9. Sous « Quels sont les événements qui doivent déclencher ce webhook ? », sélectionnez les types de webhooks que vous souhaitez recevoir. Abonnez-vous uniquement aux événements de webhook dont vous avez besoin.

10. Si vous avez choisi de me laisser sélectionner des événements individuels, sélectionnez les événements qui déclencheront le webhook.

11. Pour rendre le webhook actif immédiatement après l'ajout de la configuration, sélectionnez Actif.

12. Cliquez sur Ajouter un webhook.

Création d'un webhook 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. Seul le propriétaire de l'application, ou un gestionnaire de l'application pour l’application, peut créer un webhook GitHub Marketplace.

1. Naviguez vers votre page de référencement GitHub Marketplace.
2. À côté de la liste GitHub Marketplace pour laquelle vous voulez visualiser les livraisons de webhook, cliquez sur Gérer l'annonce.
3. Dans la barre latérale, cliquez sur Webhook.
4. Sous « URL de charge utile », saisissez l'URL où vous souhaitez recevoir les charges utiles.
5. Si vous le souhaitez, sélectionnez le menu déroulant Type de contenu et cliquez sur un format de données dans lequel recevoir la charge utile du webhook.
   • application/json transmettra la charge utile JSON directement dans le corps de la demande POST.
   • application/x-www-form-urlencoded enverra la charge utile JSON en tant que paramètre de formulaire appelé payload.
6. En option, sous « Secret », saisissez une chaîne de caractères à utiliser comme clé secret. Vous devez choisir une chaîne aléatoire de texte avec une entropie élevée. Vous pouvez utiliser le secret du webhook pour limiter les demandes entrantes à celles provenant de GitHub uniquement. Pour plus d’informations, consultez « Validation des livraisons de webhook ».
7. Pour rendre le webhook actif immédiatement après l'ajout de la configuration, sélectionnez Actif.
8. Cliquez sur Créer un webhook.

Après avoir créé un nouveau webhook, GitHub vous enverra un simple événement ping pour vous indiquer que vous avez correctement configuré le webhook. Pour plus d’informations, consultez « Événements et charges utiles du webhook ».

Création d'un webhook GitHub Sponsors

Vous pouvez créer un webhook pour vous abonner à des événements liés à vos parrainages. Seul le propriétaire du compte commanditaire peut créer des webhooks de parrainage pour ce compte. Pour obtenir davantage d’informations sur l’événement auquel un webhook de parrainage est abonné, consultez l’sponsorshipévénement webhook .

1. Dans le coin supérieur droit d’une page, cliquez sur votre photo de profil, puis sur Vos sponsors.
2. À côté du compte pour lequel vous voulez créer un webhook, cliquez sur Tableau de bord.
3. Dans la barre latérale gauche, cliquez sur Webhooks.
4. Cliquez sur Ajouter un webhook.
5. Sous « URL de charge utile », saisissez l'URL où vous souhaitez recevoir les charges utiles.
6. Si vous le souhaitez, sélectionnez le menu déroulant Type de contenu et cliquez sur un format de données dans lequel recevoir la charge utile du webhook.
   • application/json transmettra la charge utile JSON directement dans le corps de la demande POST.
   • application/x-www-form-urlencoded enverra la charge utile JSON en tant que paramètre de formulaire appelé payload.
7. En option, sous « Secret », saisissez une chaîne de caractères à utiliser comme clé secret. Vous devez choisir une chaîne aléatoire de texte avec une entropie élevée. Vous pouvez utiliser le secret du webhook pour limiter les demandes entrantes à celles provenant de GitHub uniquement. Pour plus d’informations, consultez « Validation des livraisons de webhook ».
8. Pour rendre le webhook actif immédiatement après l'ajout de la configuration, sélectionnez Actif.
9. Cliquez sur Créer un webhook.

Création de webhooks pour une application GitHub App

Le propriétaire de GitHub App peut s'abonner à des événements de webhook pour recevoir des notifications lorsque certains événements se produisent. Si le propriétaire de l’application a désigné des gestionnaires des applications pour une GitHub App, les gestionnaires d'applications peuvent également abonner l'application à des événements webhook. Pour plus d’informations, consultez « Utilisation de webhooks avec GitHub Apps ».

Chaque GitHub App a un webhook. Vous pouvez configurer le webhook lorsque vous inscrivez un GitHub App, ou vous pouvez modifier la configuration du webhook pour une inscription GitHub App existante.

Pour plus d'informations sur la configuration d'un webhook quand vous inscrivez un GitHub App, consultez « Inscription d’une application GitHub ».

Pour configurer un webhook pour un enregistrement GitHub App existant :

1. Dans le coin supérieur droit de n’importe quelle page sur GitHub, cliquez sur votre photo de profil.

2. Accédez aux paramètres de votre compte.

   • Pour une application appartenant à un compte personnel, cliquez sur Paramètres.
   • Pour une application appartenant à une organisation :
     1. Cliquez sur Vos organisations.
     2. À droite de l’organisation, cliquez sur Paramètres.
   • Pour une application appartenant à une entreprise :
     1. Si vous utilisez Enterprise Managed Users, cliquez sur Votre entreprise pour accéder directement aux paramètres de compte d’entreprise.
     2. Si vous utilisez des comptes personnels, cliquez sur Vos entreprises, puis à droite de l’entreprise, cliquez sur Paramètres.

3. Accédez aux paramètres de l’GitHub App.

   • Pour une application appartenant à un compte personnel ou à une organisation :
     1. Dans la barre latérale gauche, cliquez sur Paramètres du développeur, puis cliquez sur GitHub Apps.
   • Pour une application appartenant à une entreprise :
     1. Dans la barre latérale gauche, sous « Paramètres », cliquez sur GitHub Apps.

4. À côté du GitHub App pour lequel vous voulez configurer le webhook, cliquez sur Modifier.

5. Sous « Webhook », sélectionnez Actif.

6. Sous « URL du webhook », saisissez l’adresse à laquelle vous souhaitez recevoir les charges utiles.

7. En option, sous « Secret de webhook », saisissez une chaîne à utiliser comme clé secret. Vous devez choisir une chaîne aléatoire de texte avec une entropie élevée. Vous pouvez utiliser le secret du webhook pour limiter les demandes entrantes à celles provenant de GitHub. Pour plus d’informations, consultez « Validation des livraisons de webhook ».

8. Cliquez sur Save changes.

9. Dans la barre latérale, cliquez sur Autorisations et événements.

10. Les événements webhook spécifiques que vous pouvez sélectionner dans votre inscription d’GitHub App sont déterminés par le type d’autorisations que vous avez sélectionné pour votre application. Vous devez d’abord sélectionner les autorisations que vous souhaitez que votre application dispose, puis vous pouvez abonner votre application aux événements de webhook liés à cet ensemble d’autorisations.

    Sous les sections « Autorisations de dépôt », « Autorisations d'organisation » et « Autorisations de compte », sélectionnez les autorisations requises pour les événements auxquels votre application s'abonnera. Pour plus d’informations, consultez « Choix des autorisations pour une application GitHub ». Pour plus d'informations sur les éléments à prendre en compte lors de la modification des autorisations, consultez « Modification d'une inscription GitHub App.

11. Sous « S'abonner aux événements », sélectionnez les événements de webhook que vous souhaitez que votre GitHub App reçoive.

12. Cliquez sur Save changes.

Vous pouvez également utiliser l'API REST pour créer un webhook pour un GitHub App. Pour plus d’informations, consultez « Points de terminaison d’API REST pour GitHub App webhooks ».

Pour aller plus loin

• À propos des webhooks
• Gestion des livraisons de webhooks