Concept
Un Webhook est un système de notification aussi appelé « fonction de rappel ». Un webhook a pour but de transmettre des données d’une application à une autre en temps réel, sans qu’une demande soit nécessaire. Pour ce faire, l’application qui reçoit les données configure un point de terminaison (une URL de son serveur sur laquelle il recevra les notification webhooks) et spécifie les événements pour lesquels elle souhaite être notifiée.
Ainsi à chaque fois que l’un des événement se déclenche, l’outil connecté pousse automatiquement les données au serveur.
Le webhook est donc toujours à l’initiative de l’outil connecté. A la différence d’une requête API, qui elle est une demande faite à l’initiative du serveur vers l’outil connecté pour obtenir ou modifier des données.
Pour utiliser cette fonctionnalité, vous devez simplement ouvrir un point d’accès (endpoint) sur votre système capable d’interpréter les informations envoyées par ProAbono. Et ensuite configurer un webhook dans ProAbono en renseignant l’URL de rappel et en sélectionnant les évènements pour lesquels vous voulez être notifiés.
Ex: Si un évènement « Démarrage d’un Abonnement (SubscriptionStarted ) » se produit, une notification est envoyée vers l’URL spécifiée (https://mywebsite.com/proabono-events).
Processus associés
| Actions | Rôle | Conséquences |
| Création d’un webhook | Ajoute une nouvelle fonction de rappel, en associant un ou plusieurs évènement à une URL de destination. |
|
| Validation d’un webhook | Valide le bon fonctionnement des échanges entre ProAbono et l’application tierce et de s’assurer que l’application de destination et bien la bonne. |
|
| Modification d’un webhook | Met à jour l’un des attributs de la fonction de rappel: (évènements, URL de destination) | |
| Désactivation d’un webhook | Suspend l’envoi des notifications liées à cette fonction de rappel. |
|
| Réactivation d’un webhook | Relance l’écoute des évènements et l’envoi de notifications. | Si un évènement associé à ce webhook intervient alors les notifications seront à nouveau envoyées.
à noter: que l’historique des évènements n’est pas conservé et qu’il n’y a donc pas d’effet rétroactif. Les évènements qui se sont produit alors que le webhook était suspendu sont perdus. |
| Suppression d’un webhook | Retire la fonction de rappel de la liste. |
|
Cycle de vie
- Une fois créée, une étape de validation obligatoire est demandée afin de sécuriser les échanges et d’assurer la bonne réception des notifications.
- Une fois validé un webhook devient actif, ce qui a pour conséquence de déclenché l’envoi d’une notification chaque fois qu’un évènement associé se produit.
- Vous pouvez à tout moment désactiver un webhook (actif) afin de suspendre l’envoi des notifications tout en gardant les informations associées.
- Pour reprendre l’envoi des notifications il vous suffira de réactiver un webhook (suspendu).
- Si vous n’avez plus l’utilité d’un webhook, vous pouvez également le supprimer définitivement.