Créer des 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 d’événement peuvent être stockées au format JSON ou XML. Les webhooks sont généralement utilisés pour les raisons suivantes :

• Passage d'une commande
• Modification du prix d'un produit
• Notification de votre client(e) IM ou de votre téléavertisseur lorsque vous êtes hors ligne
• Collection des données pour leur entreposage
• Intégration de votre logiciel de comptabilité
• Filtrage des articles de la commande et envoi des informations sur la commande aux différents expéditeurs
• Suppression des données des clients de votre base de données lorsqu'ils désinstallent leur application

Remarque

Quand un webhook échoue, vous recevez un e‑mail à l’adresse du propriétaire de la boutique. L’e‑mail est envoyé uniquement lorsque le webhook est créé par une application de notre Shopify App Store ou par une application personnalisée. Si la destination du webhook renvoie de façon répétée une réponse de statut qui n’est pas une réponse de succès 200, l’abonnement webhook est alors automatiquement supprimé de votre interface administrateur Shopify.

Événements webhook pris en charge

Lors de la création d’un webhook, vous pouvez effectuer une sélection parmi tous les événements répertoriés. Par exemple, si vous souhaitez créer un webhook qui est envoyé à chaque paiement d’une commande, sélectionnez Paiement d’une commande. Pour un autre exemple, si vous souhaitez créer un webhook qui est envoyé à chaque mise à jour d’une propriété de boutique, sélectionnez Mise à jour d’une boutique.

Tableau répertoriant les événements webhooks pris en charge disponibles dans l’interface administrateur Shopify.

Catégorie	Événements
Panier	Création d’un panier Mise à jour du panier
Paiement	Création d’un paiement Suppression d’un paiement Mise à jour d’un paiement
Collection	Création d’une collection Suppression d’une collection Mise à jour d’une collection
Client	Mise à jour du consentement au marketing par e-mail des clients Mise à jour des paramètres du compte client Création d’un(e) client(e) Suppression d’un(e) client(e) Désactivation d’un(e) client(e) Mise à jour du consentement au marketing par e-mail des clients Activation d’un(e) client(e) Création d’un groupe de clients Suppression d’un groupe de clients Mise à jour d’un groupe de clients Balises clients ajoutées Balises clients supprimées Mise à jour d’un(e) client(e)
Réduction	Réduction créée Réduction supprimée Réduction mise à jour
Commande provisoire	Création d’une commande provisoire Suppression d’une commande provisoire Mise à jour d’une commande provisoire
Traitement des commandes	Création d’une commande exécutée Le traitement de la commande ne peut pas être finalisé par le service de traitement des commandes Les rubriques du traitement de commande sont préparées pour le retrait Traitement de commande déplacé Traitement des commandes suspendu Traitement de commande reprogrammé Le traitement des commandes planifié arrive à échéance Acheminement de la commande traitée terminé Traitement de commandes annulé Demande d’annulation des ordres de traitement des commandes acceptée Demande d’annulation des ordres de traitement rejetée Demande d’annulation des ordres de traitement des commandes soumise Demande de traitement des ordres de traitement des commandes acceptée Demande de traitement pour les commandes de traitement rejetée Demande de traitement des ordres de traitement des commandes soumise Levée de la suspension du traitement des commandes Rubriques de traitement des commandes préparées pour la livraison locale Traitement des commandes fusionné Division du traitement des commandes Mise à jour d’une commande exécutée
Stocks	Création d’un article en stock Suppression d’un article en stock Mise à jour d’un article en stock Connexion du niveau de stock Déconnexion du niveau de stock Mise à jour du niveau de stock
Emplacement	Activation d’emplacement Création d’un emplacement Désactivation d’emplacement Suppression d’un emplacement Mise à jour d’un emplacement
Développer	Création d’un marché Suppression d’un marché Mise à jour d’un marché
Commande	Annulation d’une commande Création de commandes Suppression d’une commande Commande modifiée Traitement des commandes Paiement d’une commande Évaluation des risques de la commande modifiée Mise à jour d’une commande
Produit	Création d'un produit Suppression d’un produit Mise à jour d’un produit
Rembourser	Création d’un remboursement
Shop	Mise à jour d’une boutique
Mode de paiement	Création de transaction d’appel d’offres
Thème	Création d’un thème Suppression d’un thème Publication d’un thème Mise à jour d’un thème
Transaction	Création d’une transaction

Conseil

Les développeurs peuvent se référer à la liste complète des sujets relatifs aux webhooks lors de la création d’abonnements webhook.

Création de webhooks

Vous pouvez créer un webhook à tout moment. Vos webhooks sont signés d’un ID consistant en une combinaison de lettres et de chiffres uniques pour votre boutique.

Étapes :

Bureau

1. Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.

2. Cliquez sur Webhooks.

3. Cliquez sur ⊕ Créer un webhook.

4. Dans le menu déroulant Événement, sélectionnez l’un des événements webhooks pris en charge que vous souhaitez utiliser. Vous ne pouvez pas modifier l’événement webhook après la création du webhook.

5. Dans le menu déroulant Format, choisissez le format dans lequel vous souhaitez que Shopify vous envoie ces informations. Les deux options sont JSON ou XML.

6. 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é lié à la boutique
   • Des « faux » domaines (par exemple, www.example.com)
   • Domaines Shopify (par exemple, shopify.com et myshopify.com)

7. Dans la version de l’API webhook, sélectionnez la version de webhook que vous préférez.

8. Cliquez sur Enregistrer.

iPhone

1. Depuis l’application Shopify, appuyez sur le bouton …, puis sur Paramètres.

2. Dans la section Paramètres de la boutique, appuyez sur Notifications.

3. Appuyez sur Webhooks.

4. Appuyez sur ⊕ Créer un webhook.

5. Dans le menu déroulant Événement, sélectionnez l’un des événements webhooks pris en charge que vous souhaitez utiliser. Vous ne pouvez pas modifier l’événement webhook après la création du webhook.

6. Dans le menu déroulant Format, choisissez le format dans lequel vous souhaitez que Shopify vous envoie ces informations. Les deux options sont JSON ou XML.

7. 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é lié à la boutique
   • Des « faux » domaines (par exemple, www.example.com)
   • Domaines Shopify (par exemple, shopify.com et myshopify.com)

8. Dans la version de l’API webhook, sélectionnez la version de webhook que vous préférez.

9. Appuyez sur Enregistrer.

Android

1. Dans l’application Shopify, appuyez sur le bouton ☰, puis sur Paramètres.

2. Dans la section Paramètres de la boutique, appuyez sur Notifications.

3. Appuyez sur Webhooks.

4. Appuyez sur ⊕ Créer un webhook.

5. Dans le menu déroulant Événement, sélectionnez l’un des événements webhooks pris en charge que vous souhaitez utiliser. Vous ne pouvez pas modifier l’événement webhook après la création du webhook.

6. Dans le menu déroulant Format, choisissez le format dans lequel vous souhaitez que Shopify vous envoie ces informations. Les deux options sont JSON ou XML.

7. 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é lié à la boutique
   • Des « faux » domaines (par exemple, www.example.com)
   • Domaines Shopify (par exemple, shopify.com et myshopify.com)

8. Dans la version de l’API webhook, sélectionnez la version de webhook que vous préférez.

9. Appuyez sur ✓.

Une fois votre nouveau webhook enregistré, il s’affiche sur la page Webhooks.

Modifier les webhooks

Vous pouvez modifier la configuration d’un webhook après sa création. Toutefois, vous ne pouvez pas modifier l’événement webhook sélectionné.

Étapes :

Bureau

1. Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.

2. Cliquez sur Webhooks.

3. Dans le rang contenant le webhook que vous souhaitez modifier, cliquez sur ... > Modifier.

4. Dans la boîte de dialogue Modifier un webhook, modifiez-le si nécessaire.

5. Cliquez sur Enregistrer.

iPhone

1. Depuis l’application Shopify, appuyez sur le bouton …, puis sur Paramètres.
2. Dans la section Paramètres de la boutique, appuyez sur Notifications.
3. Appuyez sur Webhooks.
4. Dans le rang contenant le webhook que vous voulez modifier, appuyez sur ... > Modifier.
5. Dans la boîte de dialogue Modifier un webhook, modifiez-le si nécessaire.
6. Appuyez sur Enregistrer.

Android

1. Dans l’application Shopify, appuyez sur le bouton ☰, puis sur Paramètres.
2. Dans la section Paramètres de la boutique, appuyez sur Notifications.
3. Appuyez sur Webhooks.
4. Dans le rang contenant le webhook que vous voulez modifier, appuyez sur ... > Modifier.
5. Dans la boîte de dialogue Modifier un webhook, modifiez-le si nécessaire.
6. Appuyez sur ✓.

Tester les webhooks

Vous pouvez tester votre webhook pour vous assurer que les informations d’événement que vous voulez sont envoyées à l’URL correcte.

Étapes :

Bureau

1. Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.

2. Cliquez sur Webhooks.

3. Dans le rang contenant le webhook que vous voulez modifier, cliquez sur ... > Envoyer un test.

4. Sur l’URL que vous avez spécifiée pour le webhook, vérifiez que la notification fonctionne.

iPhone

1. Depuis l’application Shopify, appuyez sur le bouton …, puis sur Paramètres.
2. Dans la section Paramètres de la boutique, appuyez sur Notifications.
3. Appuyez sur Webhooks.
4. Dans le rang contenant le webhook que vous souhaitez tester, appuyez sur ... > Envoyer un test.
5. Sur l’URL que vous avez spécifiée pour le webhook, vérifiez que la notification fonctionne.

Android

1. Dans l’application Shopify, appuyez sur le bouton ☰, puis sur Paramètres.
2. Dans la section Paramètres de la boutique, appuyez sur Notifications.
3. Appuyez sur Webhooks.
4. Dans le rang contenant le webhook que vous souhaitez tester, appuyez sur ... > Envoyer un test.
5. Sur l’URL que vous avez spécifiée pour le webhook, vérifiez que la notification fonctionne.

Supprimer les webhooks

Vous pouvez supprimer un webhook depuis votre interface administrateur Shopify. Cette action est irréversible.

Remarque

Si la destination du webhook renvoie de façon répétée une réponse de statut qui n’est pas une réponse de succès 200, l’abonnement webhook est alors automatiquement supprimé de votre interface administrateur Shopify.

Étapes :

Bureau

1. Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.

2. Cliquez sur Webhooks.

3. Dans le rang contenant le webhook que vous voulez supprimer, cliquez sur ... > Supprimer.

iPhone

1. Depuis l’application Shopify, appuyez sur le bouton …, puis sur Paramètres.
2. Dans la section Paramètres de la boutique, appuyez sur Notifications.
3. Appuyez sur Webhooks.
4. Dans le rang contenant le webhook que vous voulez supprimer, appuyez sur ... > Supprimer.

Android

1. Dans l’application Shopify, appuyez sur le bouton ☰, puis sur Paramètres.
2. Dans la section Paramètres de la boutique, appuyez sur Notifications.
3. Appuyez sur Webhooks.
4. Dans le rang contenant le webhook que vous voulez supprimer, appuyez sur ... > Supprimer.