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

É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.

Tableau répertoriant les événements de webhook pris en charge disponibles dans l’interface administrateur Shopify.
CatégorieÉvénements
Panier
  • Création de panier
  • Mise à jour du panier
Paiement
  • Création de paiement
  • Suppression de paiement
  • Mise à jour du paiement
Collection
  • Création de collection
  • Suppression de collection
  • Mise à jour de la collection
Client
  • Mise à jour du consentement au marketing par SMS du client
  • Mise à jour des paramètres du compte client
  • Création de client
  • Suppression de client
  • Désactivation du client
  • Mise à jour du consentement au marketing par e-mail du client
  • Activation du client
  • Création de groupe de clients
  • Suppression de groupe de clients
  • Mise à jour du groupe de clients
  • Ajout de balises au client
  • Suppression de balises du client
  • Mise à jour du client
Réduction
  • Création de réduction
  • Suppression de réduction
  • Mise à jour de la réduction
Commande provisoire
  • Création de commande provisoire
  • Suppression de commande provisoire
  • Mise à jour de la commande provisoire
Traitement des commandes
  • Création du traitement de la commande
  • Le service de traitement des commandes ne peut pas finaliser l’ordre de traitement.
  • Articles de l’ordre de traitement préparés pour le retrait.
  • Ordre de traitement déplacé.
  • Ordre de traitement suspendu.
  • Ordre de traitement reprogrammé.
  • Échéance d’un ordre de traitement programmé.
  • Acheminement de l’ordre de traitement terminé.
  • Ordres de traitement annulés.
  • Demande d’annulation des ordres de traitement acceptée.
  • Demande d’annulation des ordres de traitement refusée.
  • Demande d’annulation des ordres de traitement envoyée.
  • Demande de traitement des ordres de traitement acceptée.
  • Demande de traitement des ordres de traitement refusée.
  • Demande de traitement des ordres de traitement envoyée.
  • Suspension des ordres de traitement levée.
  • Articles des ordres de traitement préparés pour la livraison locale.
  • Ordres de traitement fusionnés.
  • Ordres de traitement divisés.
  • Mise à jour du traitement de la commande
Stock
  • Création d’article en stock
  • Suppression d’article en stock
  • Mise à jour de l’article en stock
  • Connexion au niveau de stock
  • Déconnexion du niveau de stock
  • Mise à jour du niveau de stock
Emplacement
  • Activation de l’emplacement
  • Création d’emplacement
  • Désactivation de l’emplacement
  • Suppression d’emplacement
  • Mise à jour de l’article de l’emplacement
Marché
  • Création de marché
  • Suppression de marché
  • Mise à jour du marché
Commande
  • Annulation de la commande
  • Création de commande
  • Suppression de commande
  • Modification de la commande
  • Traitement de la commande
  • Paiement de la commande
  • Modification de l’évaluation des risques de la commande
  • Mise à jour de la commande
Produit
  • Création de produit
  • Suppression de produit
  • Mise à jour du produit
Remboursement
  • Création de remboursement
Boutique
  • Mise à jour de la boutique
Transaction de paiement
  • Création de transaction de paiement
Thème
  • Création de thème
  • Suppression de thème
  • Publication du thème
  • Mise à jour du thème
Transaction
  • Création de 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
  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 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éé.

  5. 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.

  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é rattaché à la boutique
    • Domaines « fictifs » (tels que www.example.com)
    • Domaines Shopify (tels que shopify.com et myshopify.com)
  7. Dans la section Version de l’API du webhook, sélectionnez la version de webhook que vous préférez.

  8. Cliquez sur Enregistrer.

Mobile
  1. Depuis l’application Shopify, appuyez sur Menu, puis sur Settings 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 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éé.

  6. 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.

  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é rattaché à la boutique
    • Domaines « fictifs » (tels que www.example.com)
    • Domaines Shopify (tels que shopify.com et myshopify.com)
  8. Dans la section Version de l’API du webhook, sélectionnez la version de webhook que vous préférez.

  9. 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
  1. Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.

  2. Cliquez sur Webhooks.

  3. Sur la ligne contenant le webhook que vous souhaitez modifier, cliquez sur ... > Modifier.

  4. Dans la boîte de dialogue Modifier le webhook, modifiez le webhook comme vous le souhaitez.

  5. Cliquez sur Enregistrer.

Mobile
  1. Depuis l’application Shopify, appuyez sur Menu, puis sur Settings Paramètres.

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

  3. Appuyez sur Webhooks.

  4. Sur la ligne contenant le webhook que vous souhaitez modifier, appuyez sur ... > Modifier.

  5. Dans la boîte de dialogue Modifier le webhook, modifiez le webhook comme vous le souhaitez.

  6. 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
  1. Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.

  2. Cliquez sur Webhooks.

  3. Sur la ligne contenant le webhook que vous souhaitez tester, cliquez sur ... > Envoyer un test.

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

Mobile
  1. Depuis l’application Shopify, appuyez sur Menu, puis sur Settings Paramètres.

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

  3. Appuyez sur Webhooks.

  4. Sur la ligne contenant le webhook que vous souhaitez tester, appuyez sur ... > Envoyer un test.

  5. À 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
  1. Depuis votre interface administrateur Shopify, accédez à Paramètres > Notifications.

  2. Cliquez sur Webhooks.

  3. Sur la ligne contenant le webhook que vous souhaitez supprimer, cliquez sur ... > Supprimer.

Mobile
  1. Depuis l’application Shopify, appuyez sur Menu, puis sur Settings Paramètres.

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

  3. Appuyez sur Webhooks.

  4. Sur la ligne contenant le webhook que vous souhaitez supprimer, appuyez sur ... > Supprimer.