Configuration d’un webhook pour vous informer des modifications du plan

Après avoir créé un brouillon de référencement GitHub Marketplace, vous pouvez configurer un webhook qui vous notifie quand le compte client fait l’objet de modifications. Après avoir configuré le webhook, vous pouvez gérer les types d’événement marketplace_purchase dans votre application.

Dans cet article

Note

Cet article s'applique uniquement à la publication d'applications dans GitHub Marketplace. Pour plus d’informations sur la publication de GitHub Actions dans GitHub Marketplace, consultez « Publication d’actions dans GitHub Marketplace ».

Le webhook d’événements GitHub Marketplace peut être configuré uniquement à partir de la page de référencement de votre application GitHub Marketplace. Vous pouvez configurer tous les autres événements à partir de la page des paramètres du développeur de votre application. Si vous n’avez pas créé de liste GitHub Marketplace, consultez « Créer un brouillon de référencement pour votre application » pour découvrir comment procéder.

Création d'un webhook

Pour créer un webhook pour votre liste GitHub Marketplace, cliquez sur Webhook dans la barre latérale gauche de votre page de référencement GitHub Marketplace. Voici des options de configuration de webhook nécessaires pour configurer votre webhook :

URL de la charge utile

L’URL de la charge utile est l’URL du serveur qui reçoit les requêtes POST des webhooks.

Type de contenu

Des webhooks peuvent être livrés à l’aide de différents types de contenus :

  • Le type de contenu application/json livre la charge utile JSON directement comme corps de la demande POST.
  • Le type de contenu application/x-www-form-urlencoded envoie la charge utile JSON en tant que paramètre de formulaire nommé payload.

Choisissez celle qui convient le mieux à vos besoins. GitHub recommande d’utiliser le type de contenu application/json.

Secret

La définition d’un secret de webhook vous permet de vous assurer que les requêtes POST envoyées à l’URL de charge utile proviennent de GitHub Enterprise Cloud. Lorsque vous définissez un secret, vous recevez les en-têtes X-Hub-Signature et X-Hub-Signature-256 dans la requête POST du webhook. Pour plus d’informations sur l’utilisation d’un secret avec un en-tête de signature pour sécuriser vos charges utiles de webhook, consultez « Validation des livraisons de webhook ».

Actif

Par défaut, la livraison de webhook est « Active ». Vous pouvez choisir de désactiver la livraison des charges utiles de webhook en désélectionnant « Actif ». Si vous avez désactivé les livraisons de webhook, vous devez sélectionner « Actif » avant de soumettre votre application à une révision.

Affichage des livraisons de webhook

Une fois que vous avez configuré votre webhook GitHub Marketplace, vous pouvez inspecter les charges utiles de demande POST à partir de la page Webhook de la liste de votre application GitHub Marketplace. GitHub ne renvoie pas les tentatives de remise ayant échoué. Vérifiez que votre application peut recevoir toutes les charges utiles de webhook envoyées par GitHub.

Capture d’écran des livraisons de webhook récentes pour le référencement GitHub Marketplace.