L’utilisation de webhooks vous permet d’être notifié en temps réel dans vos applications dès qu’une modification est apportée à une intervention de votre compte AntsRoute.
Concrètement, un webhook permet d’envoyer automatiquement des données vers une URL spécifique lorsqu’un événement se produit dans AntsRoute.
L’envoi automatisé de ces informations peut ensuite déclencher des actions dans l’application destinataire. Par exemple, vous pouvez créer automatiquement une facture dans QuickBooks dès qu’une livraison est réalisée avec AntsRoute.
💡 Seuls les utilisateurs disposant du rôle « Admin » peuvent accéder aux paramètres des webhooks.
Exemple de requête HTTP :
Événements qui peuvent être envoyés :
- Changement d’état : Livraison annulée, Livraison confirmée, Livraison créée, Livraison en attente, Livraison supprimée, Livraison réalisée, État confirmé retiré, État en attente retiré.
- Planification : Livraison passée à l’état non assigné, Livraison avancée ou reculée ou assignée à une autre tournée, Livraison assignée à une tournée, Livraison assignée à une tournée démarrée, Livraison planifiée depuis le panier, Livraison déplacée dans le panier, Date de planification changée.
- Preuves de passage : Preuve de passage (photo) ajoutée, Signature du client ajoutée.
- Autres : Livraison verrouillée, Livraison mise à jour.
- Tournée : Tournée démarrée, Tournée terminée.
- Notification : Notification envoyée
- Pick-up & Delivery : Chargement réalisé, Déchargement réalisé, Chargement annulé, Déchargement annulé.
Comment ajouter un webhook ?
Dans un premier temps, vous devez récupérer l’URL du webhook de l’application vers laquelle vous souhaitez envoyer les données.
- Cliquez sur le rond bleu en haut à droite.
- Rendez-vous dans « Intégrations ».
- Cliquez sur l’onglet «Webhooks ».
- Cliquez sur le bouton « + » en haut à droite.
- Renseignez les informations demandées : nom, adresse URL, mode d'authentification, etc.
- Sélectionnez les événements à envoyer.
- Choisissez d'inclure ou non toutes les informations des interventions (ID, état, etc.).
- Si vous avez plusieurs sites, sélectionnez les sites qui sont concernés.
- Cliquez sur le bouton « Sauvegarder ».
Votre webhook est maintenant configuré. Les données seront envoyées automatiquement à l’application concernée lorsque l’un des événements sélectionnés se produit.
Comment consulter les logs d’un webhook ?
L’onglet « Logs » vous permet de consulter l’historique des données envoyées vers vos applications tierces. Il vous aide notamment à vérifier si les informations ont bien été transmises et à identifier d’éventuelles erreurs.
Pour accéder aux logs :
- Depuis la liste de vos webhooks, identifiez le webhook concerné.
- Cliquez sur « … ».
- Cliquez sur « Logs ».
Pour chaque envoi, vous pouvez notamment consulter son statut, l’événement concerné, sa date d’envoi et les données envoyées.
💡 Un statut « Succès » indique que les informations ont bien été transmises. Un statut « Échec » indique que l’envoi n’a pas abouti.
En cas d’échec, cliquez sur la ligne concernée pour afficher le détail de l’envoi et la réponse retournée par l’application tierce. Ces informations peuvent vous aider à identifier l’origine du problème.
Comment filtrer les logs ?
Pour retrouver plus facilement un envoi dans l’historique, cliquez sur le bouton « Filtrer ».
Vous pouvez filtrer les logs selon quatre critères :
- Statut : affichez uniquement les envois en échec ou en succès.
- Événement : retrouvez les envois associés à un événement particulier, par exemple une livraison verrouillée.
- Date d’envoi : recherchez les données envoyées à une date donnée.
- Identifiant livraison : retrouvez les envois associés à une livraison précise grâce à son identifiant.
Vous pouvez ainsi isoler rapidement les informations recherchées, notamment lorsque votre webhook contient un grand nombre de logs.
💡 En cas de problème avec une livraison précise, utilisez le filtre « Identifiant livraison » pour retrouver plus rapidement les différents événements envoyés pour cette intervention.
Que faire lorsqu’un envoi est en échec ?
Si un log affiche le statut « Échec », ouvrez-le pour consulter le détail de la réponse retournée par l’application destinataire.
Vous pouvez notamment y retrouver le code de réponse HTTP et le message d’erreur. Ces informations permettent de déterminer pourquoi l’application n’a pas accepté les données envoyées.
Après avoir corrigé le problème à l’origine de l’erreur, vous pouvez cliquer sur « Renvoyer » pour effectuer une nouvelle tentative d’envoi.
💡 Si nécessaire, le bouton « Copier » vous permet également de récupérer les informations du log afin de les transmettre à votre équipe technique ou au support de l’application concernée.
À retenir
Les webhooks permettent d’automatiser l’échange d’informations entre AntsRoute et vos autres applications. Grâce aux logs et aux filtres Statut, Événement, Date d’envoi et Identifiant livraison, vous pouvez suivre plus facilement les données envoyées et identifier rapidement les éventuelles erreurs.
Besoin d’aide ?
Si vous rencontrez des difficultés pour utiliser cette fonction ou si vous avez une question, notre équipe support est là pour vous aider.
Vous pouvez contacter AntsRoute via le chat disponible depuis le logiciel ou à l’adresse suivante :
📧 contact@antsroute.com