S’abonner et gérer les webhooks
Objectifs pédagogiques
- Comprendre comment les webhooks automatisent les échanges de données en temps réel.
- Configurer un webhook dans l’interface Quable
- Gérer les erreurs et la désactivation automatique des webhooks.
Présentation
Les webhooks permettent de faire parvenir à un connecteur ou à une application tierce des notifications en temps réel lorsqu’un événement spécifique se produit dans Quable. Ces notifications sont envoyées vers une URL définie, ce qui permet d’automatiser des actions sans intervention manuelle.
Les webhooks permettent une automatisation efficace des échanges de données en temps réel. Une bonne configuration et une surveillance régulière garantissent un fonctionnement optimal et fiable.
La configuration des webhooks s’effectue directement depuis une interface dédiée, sans besoin de maîtriser de code. Cette page permet d’activer et de paramétrer facilement les notifications : voyons en détail comment utiliser cette fonctionnalité essentielle.
L'abonnement webhook est une configuration permettant de recevoir automatiquement des notifications HTTP lorsqu'un événement spécifique se produit.
Comprendre les notifications webhook
Les webhooks sont utiles pour être informé automatiquement des événements tels que :
- La création, mise à jour ou suppression d’un document, d’un média ou d’une classification.
- La finalisation d’un import, export ou d’une modification en masse.
- Les modifications des variants et des valeurs prédéfinies.
Chaque événement est regroupé dans des catégories :
- Documents,
- Médias,
- Variants,
- Liaisons,
- Classifications
- Processus.
Les notifications envoyées via webhook contiennent les données de l'événement au format JSON. L'application tierce ou le connecteur qui écoute ces notifications peut alors les exploiter pour synchroniser presque immédiatement les données en effectuant des appels API vers Quable sur les seules modifications qui ont eu lieu.
Créer des abonnement aux événements webhook
1 : Accédez aux configurations de webhook
- Depuis le menu d’administration, accédez à la page Notifications Webhook,
- Cliquez sur Créer un webhook,
2 : Créer un abonnement
- Saisissez un code pour identifier la configuration.
- Activez l’interrupteur pour passer le webhook en actif.
- Renseignez l’URL de réception (doit être en HTTPS).
- (Facultatif) Ajoutez un en-tête d’autorisation si votre système nécessite un jeton ou une clé API pour sécuriser les appels.
3 : Sélectionner les événements
Il existe trois types d'évènements pour les différents catégories d’objets :
- Créer
- Modifier
- Supprimer
- Choisissez les événements que vous souhaitez suivre parmi les catégories disponibles.
- Cliquez sur Créer pour valider la configuration.
Désactiver ou modifier un webhook
- Pour désactiver un webhook, basculez l’interrupteur de l’événement sur Inactif.
- Pour modifier un webhook, sélectionnez-le dans la liste et mettez à jour ses paramètres.
Désactivation automatique
Un webhook est désactivé si, sur les 7 derniers jours :
- Plus de 50 erreurs ont été enregistrées.
- Le nombre d’échecs dépasse le nombre de notifications réussies.
- Lorsqu’un webhook est désactivé, un email d’alerte est envoyé aux administrateurs.
Gestion des erreurs : Relance des notifications
Si un envoi échoue, Quable tente de renvoyer la notification jusqu'à trois fois. Une erreur est enregistrée si :
- La réponse HTTP n’est pas un code 2xx (succès).
- Le serveur ne répond pas dans un délai de 5 secondes.
En résumé
Qu’est-ce qu’un webhook ? Un webhook permet d’envoyer des notifications en temps réel à une application tierce lorsqu’un événement se produit dans Quable.
Quels événements suivre ? Les notifications concernent la création, la modification et la suppression d’objets (documents, médias, classifications, variants).
Comment configurer un webhook ?
- Accédez à la page des notifications webhook.
- Créez un nouvel abonnement et renseignez un code d’identification.
- Activez l’interrupteur et renseignez l’URL de réception (HTTPS obligatoire).
- Sélectionnez les événements à suivre et enregistrez la configuration.
Comment gérer un webhook ?
- Vous pouvez modifier ou désactiver un webhook à tout moment.
- Un webhook est désactivé automatiquement après 50 erreurs en 7 jours si le nombre d’échecs dépasse celui des succès.
Comment les erreurs sont-elles gérées ?
- Quable tente d’envoyer la notification jusqu’à trois fois.
- Une erreur est enregistrée si la réponse HTTP n’est pas en 2xx ou si le serveur ne répond pas en moins de 5 secondes.
- Une alerte par email est envoyée aux administrateurs en cas de désactivation.
Chapitre suivant
Maintenant que vous savez vous abonner et gérer les webhooks, découvrons ensemble comment Paramétrer les liaisons automatiques à l'import de média.
Updated 16 days ago