Webhooks
Un webhook permet à une entité d’envoyer automatiquement des données en temps réel ou des notifications à une autre entité lorsqu’un événement spécifique se produit. Elle permettra à une application de fournir des informations à d'autres applications sans les demander constamment. Par exemple, si un utilisateur termine un cours sur un système de gestion de l’apprentissage (LMS), un webhook peut automatiquement envoyer ces informations à une autre plate-forme, telle qu’un outil de gestion de la relation client ou de création de rapports. Les webhooks sont souvent utilisés dans les intégrations pour automatiser les processus et réduire le besoin de mises à jour manuelles entre les systèmes. Configurez les webhooks en fournissant une URL de rappel à laquelle vous enverriez les données.
Webhooks et API
Les webhooks et les API aident les systèmes à communiquer entre eux, mais leur fonctionnement est différent. Avec les API, les informations sont partagées uniquement lorsque l’utilisateur en fait la demande. Par exemple, si un élève a besoin des données de progression du cours, il envoie une demande à l’API, qui fournit alors les informations. D’autre part, les webhooks envoient automatiquement des données immédiatement lorsqu’un événement se produit. Par exemple, si un élève termine un cours, il envoie immédiatement les données à l'URL du processus d'écoute sans aucune demande manuelle.
Que sont les API en temps réel ?
Les API en temps réel permettent aux applications d’effectuer un exchange instantané des données lorsqu’un événement se produit. Contrairement aux API traditionnelles, qui attendent qu’un utilisateur demande des informations, les API en temps réel partagent des données dès qu’elles se produisent. Les webhooks agissent comme une API en temps réel et permettent de partager les données immédiatement chaque fois que l’événement spécifié se produit. L’API en temps réel garantit que ce transfert de données s’effectue immédiatement, sans qu’aucune demande manuelle ne soit nécessaire, ce qui permet aux systèmes de rester mis à jour instantanément.
Événements de webhook
Les événements de webhook sont des actions spécifiques se produisant dans un système qui envoie automatiquement des données à une URL de processus d’écoute. Par exemple, lorsqu’un élève s’inscrit à un cours, un événement webhook est déclenché et envoie les détails d’inscription à l’URL du processus d’écoute.
Les événements de webhook sont classés en deux catégories :
- Événements en temps réel : les événements sont traités et envoyés en temps réel à une URL cible
- Événements hors temps réel : les événements sont traités par lots et envoyés à des heures spécifiées et non en temps réel
URL du processus d’écoute
Une URL de processus d'écoute est un point de terminaison ou une destination qui reçoit des informations de données lorsqu'un événement se produit. Chaque fois qu'un événement spécifique se produit, tel qu'un utilisateur s'inscrivant à un cours, le système envoie automatiquement les détails à cette URL sans aucune demande manuelle. L’URL du processus d’écoute est l’adresse à laquelle toutes ces mises à jour sont envoyées.
Le webhook envoie les informations pertinentes au format JSON. Voici un exemple de charge utile pour un événement déclenché dans Adobe Learning Manager :
{
"accountId": 1010,
"events": [
{
"eventId": "d5fb7071-10a9-46b2-9f9e-79dde346c052",
"eventName": "COURSE_ENROLLMENT_BATCH",
"timestamp": 1727414643000,
"eventInfo": "1727414643000-047210-84242-0",
"data": {
"userId": 4279332,
"loId": "course:7374992",
"loInstanceId": "course:7376092_10250977",
"loType": "course",
"enrollmentSource": "ADMIN_ENROLL",
"dateEnrolled": 1727414643
}
}
]
}
Création et gestion des webhooks - Administrateur de l’intégration
Suivez les étapes ci-dessous pour créer une intégration Webhooks dans Adobe Learning Manager :
-
Connectez-vous en tant qu'administrateur d'intégration.
-
Sur la page d’accueil, sélectionnez Webhooks > Ajouter un webhook.
Ajouter un webhook -
Saisissez le nom et la description du webhook.
-
Tapez l'URL du processus d'écoute en tant que URL cible où vous souhaitez transmettre les données d'événement.
-
Sélectionnez l’une des méthodes d’authentification :
L’authentification dans Webhooks est une méthode de sécurité permettant de s’assurer que les données envoyées à une URL de processus d’écoute proviennent d’une source approuvée.- Aucun : aucune authentification requise.
- De base : il s'agit d'une authentification basée sur les informations d'identification. Saisissez le nom d’utilisateur et le mot de passe.
- Signature : le système crée une signature spéciale et l’ajoute aux données du webhook. Le serveur de réception vérifie ce code pour s'assurer que les données sont réelles et n'ont pas été modifiées. Générez une signature et utilisez-la pour l’authentification. Téléchargez la signature au format JSON.
-
Sélectionnez les événements Webhook dans la liste déroulante Déclencher des événements.
note note NOTE Vous pouvez également tester les webhooks en sélectionnant l’option Tester les webhooks dans la page Ajouter un webhook. -
Sélectionnez l’option État d’activation pour activer le webhook. Une fois cette option activée, les données sont transmises chaque fois que les événements sélectionnés se produisent.
Modifier les webhooks - Administrateur de l’intégration
Procédez comme suit pour modifier des webhooks à partir de Adobe Learning Manager :
-
Connectez-vous en tant qu'administrateur d'intégration.
-
Sélectionnez Webhooks sur la page d’accueil.
-
Sélectionnez le webhook que vous souhaitez modifier.
Modifier le webhook -
Sélectionnez Modifier pour modifier les détails du webhook et sélectionnez Enregistrer.
Suppression des webhooks - Administrateur de l’intégration
Procédez comme suit pour modifier des webhooks à partir de Adobe Learning Manager :
- Connectez-vous en tant qu'administrateur d'intégration.
- Sélectionnez Webhooks sur la page d’accueil.
- Sélectionnez le webhook à supprimer.
- Sélectionnez Supprimer pour supprimer les webhooks.
Supprimer le webhook
Retrait des webhooks - Administrateur de l’intégration
Procédez comme suit pour retirer les webhooks :
- Connectez-vous en tant qu'administrateur d'intégration.
- Sélectionnez Webhooks sur la page d’accueil.
- Sélectionnez le webhook que vous souhaitez modifier.
- Sélectionnez Modifier et désactivez État d’activation pour retirer le webhook.
Retrait du webhook