Création de webhooks
Les webhooks sont un outil permettant de récupérer et de stocker les données d’un certain événement. Ils vous permettent d’enregistrer une URL https:// où les données de l’événement peuvent être stockées aux formats JSON ou XML. Les webhooks sont couramment utilisés pour les raisons suivantes :
- Passage d’une commande
- Modification du prix d’un produit
- Notification de votre client de messagerie instantanée ou de votre bipeur lorsque vous êtes hors ligne
- Collecte de données pour l’entreposage de données
- Intégration de votre logiciel de comptabilité
- Filtrage des articles de la commande et information des divers expéditeurs au sujet de la commande
- Suppression des données client de votre base de données lorsqu’ils désinstallent votre appli
Sur cette page
Événements de webhook pris en charge
Lorsque vous créez un webhook, vous pouvez sélectionner n’importe lequel des événements répertoriés. Par exemple, si vous souhaitez créer un webhook qui est envoyé chaque fois qu’une commande a été payée, sélectionnez Paiement de la commande. Autre exemple : si vous souhaitez créer un webhook qui est envoyé chaque fois qu’une propriété de la boutique est mise à jour, sélectionnez Mise à jour de la boutique.
| Catégorie | Événements |
|---|---|
| Panier |
|
| Paiement |
|
| Collection |
|
| Client |
|
| Réduction |
|
| Commande provisoire |
|
| Traitement des commandes |
|
| Stock |
|
| Emplacement |
|
| Marché |
|
| Commande |
|
| Produit |
|
| Remboursement |
|
| Boutique |
|
| Transaction de paiement |
|
| Thème |
|
| Transaction |
|
Création de webhooks
Vous pouvez créer un webhook à tout moment. Vos webhooks sont signés avec un ID composé d’une combinaison de lettres et de chiffres propre à votre boutique.
Étapes :
Bureau
Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.
Cliquez sur Webhooks.
Cliquez sur ⊕ Créer un webhook.
Dans le menu déroulant Événement, sélectionnez l’un des événements webhook pris en charge que vous souhaitez utiliser comme événement webhook. Vous ne pouvez pas modifier l’événement webhook une fois que le webhook a été créé.
Dans le menu déroulant Format, choisissez le format dans lequel vous souhaitez que Shopify vous envoie ces informations. Les deux choix sont JSON ou XML.
Dans le champ URL, saisissez l’URL où vous souhaitez que les données soient stockées. Les webhooks ne peuvent pas être renvoyés aux URL suivantes :
- Localhost
- Toute URL se terminant par le mot « internal » (par exemple,
example.com/internal) - Toute URL de n’importe quel domaine personnalisé rattaché à la boutique
- Domaines « fictifs » (tels que
www.example.com) - Domaines Shopify (tels que
shopify.cometmyshopify.com)
Dans la section Version de l’API du webhook, sélectionnez la version de webhook que vous préférez.
Cliquez sur Enregistrer.
Mobile
Depuis l’application Shopify, appuyez sur
, puis sur
Paramètres.
Dans la section Paramètres de la boutique, appuyez sur Notifications.
Appuyez sur Webhooks.
Appuyez sur ⊕ Créer un webhook.
Dans le menu déroulant Événement, sélectionnez l’un des événements webhook pris en charge que vous souhaitez utiliser comme événement webhook. Vous ne pouvez pas modifier l’événement webhook une fois que le webhook a été créé.
Dans le menu déroulant Format, choisissez le format dans lequel vous souhaitez que Shopify vous envoie ces informations. Les deux choix sont JSON ou XML.
Dans le champ URL, saisissez l’URL où vous souhaitez que les données soient stockées. Les webhooks ne peuvent pas être renvoyés aux URL suivantes :
- Localhost
- Toute URL se terminant par le mot « internal » (par exemple,
example.com/internal) - Toute URL de n’importe quel domaine personnalisé rattaché à la boutique
- Domaines « fictifs » (tels que
www.example.com) - Domaines Shopify (tels que
shopify.cometmyshopify.com)
Dans la section Version de l’API du webhook, sélectionnez la version de webhook que vous préférez.
Appuyez sur Enregistrer ou sur ✓.
Une fois votre nouveau webhook enregistré, il s’affiche sur la page Webhooks.
Modification de webhooks
Vous pouvez modifier la configuration d’un webhook après sa création. Cependant, vous ne pouvez pas modifier l’événement webhook sélectionné.
Étapes :
Bureau
Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.
Cliquez sur Webhooks.
Sur la ligne contenant le webhook que vous souhaitez modifier, cliquez sur ... > Modifier.
Dans la boîte de dialogue Modifier le webhook, modifiez le webhook comme vous le souhaitez.
Cliquez sur Enregistrer.
Mobile
Depuis l’application Shopify, appuyez sur
, puis sur
Paramètres.
Dans la section Paramètres de la boutique, appuyez sur Notifications.
Appuyez sur Webhooks.
Sur la ligne contenant le webhook que vous souhaitez modifier, appuyez sur ... > Modifier.
Dans la boîte de dialogue Modifier le webhook, modifiez le webhook comme vous le souhaitez.
Appuyez sur Enregistrer ou sur ✓.
Test de webhooks
Vous pouvez tester votre webhook pour vous assurer que les informations d’événement que vous souhaitez sont bien envoyées à la bonne URL.
Étapes :
Bureau
Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.
Cliquez sur Webhooks.
Sur la ligne contenant le webhook que vous souhaitez tester, cliquez sur ... > Envoyer un test.
À l’URL que vous avez spécifiée pour le webhook, vérifiez que la notification fonctionne.
Mobile
Depuis l’application Shopify, appuyez sur
, puis sur
Paramètres.
Dans la section Paramètres de la boutique, appuyez sur Notifications.
Appuyez sur Webhooks.
Sur la ligne contenant le webhook que vous souhaitez tester, appuyez sur ... > Envoyer un test.
À l’URL que vous avez spécifiée pour le webhook, vérifiez que la notification fonctionne.
Suppression de webhooks
Vous pouvez supprimer un webhook depuis votre interface administrateur Shopify. Cette action est irréversible.
Étapes :
Bureau
Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.
Cliquez sur Webhooks.
Sur la ligne contenant le webhook que vous souhaitez supprimer, cliquez sur ... > Supprimer.
Mobile
Depuis l’application Shopify, appuyez sur
, puis sur
Paramètres.
Dans la section Paramètres de la boutique, appuyez sur Notifications.
Appuyez sur Webhooks.
Sur la ligne contenant le webhook que vous souhaitez supprimer, appuyez sur ... > Supprimer.