Webhook

CONFIGURER UN WEBHOOK DANS SHIPPINGBO

Shippingbo vous permet de configurer des webhooks facilement dans l'interface, pour que vous puissiez être notifié en temps réel d'un changement susceptible de mettre à jour des informations dès qu'il se produit.

Ajouter un Webhook 

 

Étape 1 : Rendez-vous dans le menu Configurations -> Compte -> Webhooks et cliquer sur le bouton "Ajouter" :

 

REMARQUE

Vous pouvez accéder directement à la documentation des Webhooks sans avoir créé de hook au préalable en cliquant sur "Documentation" : 

 

Étape 2 : Remplissez les éléments nécessaires à la génération du webhook : 

  • Classe objet : Ressource sur laquelle vous souhaitez être notifié. 
  • Champ : si vous souhaitez filtrer sur un champ particulier de cette ressource
  • URL : URL sur lequel vous souhaitez être appelé
  • Depuis la valeur : Valeur de départ que doit avoir le champ pour déclencher le webhook
  • A la valeur : Valeur d'arrivée que doit avoir le champ pour déclencher le webhook


 

ATTENTION

L'URL doit commencer obligatoirement par "'https" si vous souhaitez que votre webhook fonctionne. 

 

 

REMARQUE

2 Champs sont obligatoires pour la configuration de la génération du webhook : 

  • La classe objet
  • L'URL

Si vous ne remplissez que ces deux éléments, vous serez notifié pour tous les changements impactant la classe objet choisie.

 

Exemple 1 : de webhook disponible sur Shippingbo : 

Si vous souhaitez être notifié sur l'URL, https:// shippingbo.com/webhooks/stock_variation à chaque fois que le stock d'un produit est impacté, voici les éléments à renseigner :

Exemple 2 : de webhook disponible sur Shippingbo : 

Si vous souhaitez être notifié sur l'URL, https://shippingbo.com/webhooks/orders_shipped à chaque fois qu'une commande passe expédiée,  voici les éléments à renseigner :

Une fois votre webhook créé, ce dernier apparaît dans le menu Webhooks, vous pouvez le supprimer à tout moment en cliquant sur le bouton "Supprimer":