Que sont les webhooks et comment les configurer dans Sendcloud? – Sendcloud Help Center

Objectif: apprendre les bases des webhooks et comment les configurer dans votre compte Sendcloud.

Pour utiliser les webhooks, vous devez vous connecter à Sendcloud via l'API. Pour plus d'informations sur la connexion avec notre API, nous vous renvoyons à notre documentation API.

Pour plus d'informations sur les webhooks Sendcloud, vous pouvez consulter les sections Webhooks de notre documentation API.

Pour le support des webhooks spécifique à l'intégration, consultez notre article : Amélioration de la sécurité et du support d'intégration des webhooks. Il couvre la configuration des webhooks pour différentes intégrations et les meilleures pratiques pour sécuriser vos webhooks.

Que sont les webhooks?

Les webhooks permettent aux applications de communiquer entre elles en "temps réel". Elles peuvent aussi communiquer en passant par une API. Contrairement à une API qui fonctionne par polling, un webhook reçoit des données dès que l'application les traite. Il n'est pas nécessaire de faire une demande car il s'agit d'un processus automatique. Vous n'avez donc pas à vous soucier du retard de communication.

API: une API extrait de manière temporaire les données de l'application en faisant une demande.

Webhook: un webhook ne tire pas de données mais reçoit des données envoyées par l'application dès qu'elles arrivent.

Exemple: recevoir des mises à jour de suivi de Sendcloud

(Voir l'image ci-dessous)

Lorsque vous recevez la mise à jour du suivi via l'API, voici ce qu'il se passe:
Votre application essaie d'extraire les données de suivi de Sendcloud. Elle le fera même si aucune nouvelle donnée n'est disponible.
Lorsque vous voulez recevoir des mises à jour de suivi via un webhook, voici ce qu'il se passe:
Sendcloud envoie les mises à jour de suivi vers votre application dès qu'elles sont disponibles dans Sendcloud.

Les webhooks Sendcloud

Webhook Integration Object: ce webhook entre en jeu lorsqu'une nouvelle intégration API est ajoutée à Sendcloud. Il se déclenche lorsqu'une intégration API est connectée, supprimée ou mise à jour. Cliquez ici pour voir ce que contient ce webhook.

Webhook Parcel Status Changed Object: ce webhook entre en jeu lorsqu'un colis change de statut, quel que soit le changement de statut. Cliquez ici pour voir ce que contient ce webhook.

Webhook Refund Requested Object: ce webhook entre en jeu lorsqu'un remboursement est demandé. Cliquez ici pour voir ce que contient ce webhook.

Comment configurer les webhooks dans Sendcloud?

Pour que Sendcloud communique les mises à jour des colis (comme celles de suivi), vous devez créer un endpoint API. Chaque fois qu'une mise à jour se produit, Sendcloud fera une demande via cet endpoint. Pour plus d'informations, consultez la section Webhooks dans notre documentation API.

Copiez l'url du webhook de votre application où vous le souhaitez
Allez dans votre compte Sendcloud et ouvrez vos paramètres de votre boutique en ligne en allant dans Réglages > Boutiques connectées > Modifier.
Cochez la case Webhook feedback enabled
Trouvez le champ Webhook url (voir l'image ci-dessous) et collez-y votre url de webhook.
Testez votre webhook en cliquant sur Test API webhook
Cliquez sur Enregistrer

C'est fait ! Votre webhook est maintenant configuré et les données devraient commencer à arriver dans votre application. Vous pouvez l'utiliser pour mettre en place des déclencheurs qui mènent à certaines actions. Par exemple, vous pouvez connecter vos e-mails de suivi aux mises à jour de suivi . Vous pourrez alors donner des mises à jour instantanées à vos clients.

Pour les retours, vous recevrez des mises à jour par webhook uniquement si l'envoi a été créé via l'API.

Cliquez ici pour accéder à notre référence API Sendcloud et l'utilité du webhook.