Webhooks : comment fonctionne cet écran
Les webhooks envoient les événements QrX à votre propre système au moment où ils se produisent : un paiement, un envoi, un retour, une liste de prélèvement et plus encore. QrX envoie un message signé à une adresse web (URL) que vous choisissez. Ce guide explique la liste des webhooks et chaque partie de l'éditeur de webhook.
Ce que vous voyez sur cet écran
Ajouter (en haut à droite) : créez un nouveau webhook.
Cartes de synthèse : Webhooks (tous les webhooks chargés), Actifs, Inactifs et À vérifier (webhooks qui échouent ou qui ont été désactivés automatiquement). Les chiffres portent sur les webhooks chargés dans la liste.
Rechercher des webhooks... : trouvez un webhook par nom ou par URL.
Tous, Actifs, Inactifs : affiche uniquement ces webhooks.
Actualiser (la flèche ronde) : recharge la liste.
La liste des webhooks : charge automatiquement plus de lignes quand vous faites défiler. Sur un petit écran, faites défiler le tableau sur le côté pour voir toutes les colonnes et actions.
Les colonnes
Nom : le nom que vous avez donné au webhook, son URL et la version de l'API. Cliquez sur le nom pour l'ouvrir. Cliquez sur le titre de la colonne pour trier par nom.
Canal : Tous les Canaux, ou le seul canal de vente auquel ce webhook est limité.
Événements : le nombre d'événements écoutés par le webhook, avec les deux premiers noms.
Statut : Actif, Désactivé (vous l'avez coupé), Dégradé (les livraisons échouent en ce moment), Désactivé automatiquement (QrX l'a coupé après 24 heures d'échecs) ou En échec (plusieurs livraisons de suite ont échoué).
Livrés · 24 h et Échecs · 24 h : livraisons réussies et échouées des dernières 24 heures.
Mis à jour : la dernière modification du webhook et l'heure de la dernière livraison. Cliquez sur le titre de la colonne pour trier par date.
Actions sur une ligne
Réactiver la livraison (icône marche/arrêt, uniquement sur les webhooks inactifs) : rallume le webhook. Les livraisons reprennent tout de suite.
Modifier (crayon) : ouvre le webhook.
Copier : ouvre un nouveau webhook avec le même nom (plus "copy"), les mêmes événements, le même canal, la même version d'API, les mêmes champs de payload et les mêmes destinataires d'alertes. L'URL reste vide pour que vous saisissiez la nouvelle adresse. Rien n'est créé avant l'enregistrement.
Supprimer (corbeille) : vous demande de confirmer, puis supprime le webhook. Les livraisons s'arrêtent et cette action est irréversible.
Créer ou modifier un webhook
Cliquez sur Ajouter (ou sur un webhook de la liste). Le menu de gauche indique aussi combien d'événements sont activés, par exemple 3/33. L'éditeur a une barre en haut et un menu à gauche (Point de terminaison, Événements, Sécurité, Alertes, Livraisons, Zone de danger) pour aller à chaque partie. Sécurité, Livraisons et Zone de danger apparaissent une fois le webhook enregistré.
Modifications non enregistrées ou Toutes les modifications enregistrées : indique s'il vous reste à enregistrer.
Enregistrer : enregistre le webhook. Vous pouvez aussi appuyer sur Ctrl+S (Cmd+S sur Mac).
Annuler : retour à la liste sans enregistrer.
Envoyer un Test (webhooks enregistrés uniquement) : envoie un événement de test à votre URL. Si le webhook écoute plusieurs événements, choisissez d'abord l'événement de test dans le champ à côté. Le résultat apparaît sous Livraisons après quelques secondes. Les événements de test sont envoyés même quand le webhook est coupé, pour que vous puissiez vérifier votre point de terminaison avant de le rallumer.
Copier (webhooks enregistrés uniquement) : crée un nouveau webhook à partir de celui-ci, comme Copier dans la liste.
Sous la barre, vous voyez l'URL (cliquez dessus pour la copier), le statut, le canal, la version d'API, le nombre d'événements et la date de création. Pour un webhook enregistré, vous voyez aussi la santé des livraisons : Taux de réussite, Latence médiane (la vitesse de réponse de votre point de terminaison), Livraisons · 24h et Échecs · 24 h (avec le nombre en attente d'une nouvelle tentative).
Si le webhook échoue ou est coupé, une bannière colorée en explique la raison. Sur un webhook coupé, cliquez sur Réactiver dans la bannière pour relancer les livraisons.
Point de terminaison
Nom (obligatoire) : un nom que vous reconnaissez, par exemple "Mon intégration".
URL du point de terminaison (obligatoire) : l'adresse qui reçoit les messages. Elle doit commencer par https://. Quand QrX a livré avec succès à cette URL, vous voyez Vérifié par livraison.
Canal : gardez Tous les Canaux, ou limitez le webhook à un seul canal de vente.
Version API : le format de message attendu par votre point de terminaison. La plus récente est marquée Dernière.
Actif : désactivez-le pour mettre les livraisons en pause sans supprimer le webhook. Les événements survenus pendant la pause sont ignorés, ils ne sont pas envoyés plus tard.
Événements
Choisissez quels événements envoient un message. Les événements sont regroupés par sujet, et les noms des groupes s'affichent dans votre langue : Transaction, Envoi, Commande, Paiement, Livraison, Retour, Traitement, Entrées et Stock, ainsi que les événements de listes de prélèvement.
Cliquez sur un événement pour l'activer ou le désactiver. Utilisez Tout sélectionner ou Tout désélectionner sur un groupe, et la flèche pour ouvrir ou fermer un groupe.
Filtrer les événements… : tapez une partie du nom d'un événement pour le trouver.
Le compteur indique combien d'événements disponibles sont activés, par exemple "3 / 33 événements abonnés".
Personnaliser la charge utile (l'icône de curseurs à côté d'un événement activé) : choisissez les champs que contient le message. Vous voyez chaque champ avec son type, les champs Requis (toujours envoyés), un Payload Exemple que vous pouvez copier, Tout sélectionner et Réinitialiser. Votre choix s'applique à tous les événements du même groupe. Cliquez sur Terminé pour fermer ; le choix est conservé quand vous enregistrez le webhook.
Le groupe Stock compte deux événements : stock/adjusted (le stock d'un article a changé dans un entrepôt) et stock/low (un article est descendu à son seuil d'alerte de stock faible ou en dessous ; envoyé une fois par baisse). Quand un partenaire logistique détient votre stock, vous recevez ces événements pour vos propres articles, sans les emplacements.
Les documents d'entrepôt ont leurs propres groupes : Réceptions (receipt/created, receipt/line_received, receipt/completed), Commandes fournisseur (purchase_order/created, purchase_order/sent, purchase_order/received, purchase_order/closed), Inventaires (count/completed, count/approved), Conteneurs (container/created, container/moved, container/emptied), Tâches d'équipe (task/created, task/completed) et Transferts (transfer/sent, transfer/received, transfer/completed, transfer/cancelled : du stock déplacé entre vos propres entrepôts ; transfer/received est envoyé à chaque réception et liste les lignes reçues, et chaque événement de transfert contient le transporteur et le suivi). Traitement contient aussi picklist/assigned, picklist/cancelled, picklist/batch_created et fulfilment/snoozed (une commande a été mise en pause ou sa pause a été levée). Ces événements et ceux de Entrées n'appartiennent à aucun canal de vente : chaque webhook de votre compte qui les sélectionne les reçoit, y compris un webhook limité à un seul canal. Chaque nouvel événement a un exemple de payload ; aucun ne contient de prix ni de coûts.
fulfilment/picked est envoyé une fois par commande, quand le prélèvement de cette commande sur le téléphone est terminé.
L'exemple de payload des événements de stock, de listes de prélèvement et de traitement des commandes montre un exemple complet du message, pour que vous voyiez chaque champ avant de construire votre intégration.
Sécurité
Secret de Signature : QrX signe chaque message avec ce secret. Utilisez l'icône en forme d'œil pour l'afficher ou le masquer et l'icône de copie pour le copier.
Rotation… : crée un nouveau secret. Tous les messages suivants sont signés tout de suite avec le nouveau, mettez donc d'abord le secret à jour dans votre système.
Exemples de code (Node, C#, Python, PHP, cURL) : montrent comment votre système vérifie la signature.
En-têtes de requête signés : chaque message contient X-QrX-Signature (la signature du corps du message), X-QrX-Event (le nom de l'événement) et X-QrX-Delivery-Id (un identifiant unique de la livraison).
Alertes (Notifications d'échec)
Cliquez sur Ajouter un destinataire et choisissez des collègues de votre équipe. Ils reçoivent un e-mail quand ce webhook continue d'échouer : un avertissement après 6 heures d'échecs consécutifs, et un message quand QrX coupe le webhook après 24 heures. Cliquez sur le X à côté d'un nom pour le retirer. Enregistrez le webhook pour garder la modification.
Livraisons (Journaux de Livraison)
Chaque message que QrX a envoyé à ce webhook, du plus récent au plus ancien. Les nouvelles livraisons apparaissent d'elles-mêmes tant que le badge En direct est affiché.
Recherche : trouvez des livraisons par ID de transaction, ID de commande ou événement.
Tous, Livré, Échoué, Nouvelle tentative : affiche uniquement ces livraisons.
24h, 7d, 30d : la période du graphique et des cartes de santé en haut.
Actualiser : recharge les livraisons.
Les colonnes indiquent le Statut, l'Événement, l'ID de Transaction, le Statut HTTP renvoyé par votre point de terminaison, la Durée, le numéro de Tentative et le moment où il a été Livré. Quand un message a été essayé plusieurs fois, cliquez sur la flèche au début de la ligne pour voir chaque tentative.
Voir les détails de livraison (icône en forme d'œil) : affiche la requête et la réponse complètes, avec l'erreur éventuelle.
Renvoyer : envoie à nouveau le même message.
Annuler la livraison (uniquement quand une livraison est en file d'attente ou en nouvelle tentative) : arrête les tentatives restantes.
Zone de danger
Purger l'historique de livraison : supprime définitivement les requêtes et réponses enregistrées de ce webhook. Le webhook continue de fonctionner.
Supprimer le Webhook : arrête toutes les livraisons et supprime le webhook définitivement.
Les deux demandent d'abord une confirmation et sont irréversibles.
Configurer votre premier webhook
Cliquez sur Ajouter.
Saisissez un Nom et votre URL du point de terminaison (https).
Choisissez un Canal si le webhook ne concerne qu'un seul canal.
Activez les Événements dont vous avez besoin.
Ajoutez si besoin des collègues sous Alertes.
Cliquez sur Enregistrer. La section Sécurité affiche maintenant votre secret de signature : ajoutez-le à votre système pour vérifier la signature.
Cliquez sur Envoyer un Test et vérifiez le résultat sous Livraisons.
Conseils et questions fréquentes
"Le nom est requis", "L'URL est requise", "Sélectionnez au moins un événement" : complétez la partie manquante, puis enregistrez à nouveau.
Quelqu'un d'autre a modifié le webhook en même temps : QrX affiche un message et vous permet de recharger la dernière version.
Mon webhook affiche Désactivé automatiquement : votre point de terminaison a échoué pendant 24 heures d'affilée. Corrigez votre point de terminaison, vérifiez-le avec Envoyer un Test, puis cliquez sur Réactiver. Les événements de la période où il était coupé ne sont pas envoyés automatiquement ensuite ; utilisez Renvoyer sur une livraison si vous en avez encore besoin.
Comment savoir si un message vient vraiment de QrX ? Calculez le HMAC-SHA256 du corps brut du message avec votre secret de signature et comparez-le à l'en-tête X-QrX-Signature. La section Sécurité contient des exemples prêts à l'emploi.
Besoin d'aide ? Cliquez sur Chat en bas du centre d'aide.
