Les webhooks offrent un moyen puissant d’obtenir des mises à jour en temps réel depuis votre plateforme Awardco, permettant une intégration fluide avec vos autres applications. Contrairement aux API traditionnelles qui exigent de vérifier constamment la présence de nouvelles informations, les webhooks envoient automatiquement les données à l’emplacement spécifié dès qu’un événement pertinent se produit dans Awardco. Cela garantit que vous disposez toujours des informations les plus à jour, sans aucun délai.
Actuellement, notre fonctionnalité de webhooks se concentre sur les événements de Reconnaissance, ce qui signifie que vous pouvez recevoir instantanément des données sur les reconnaissances au moment où elles se produisent dans Awardco. Ces données incluent des détails tels que l’émetteur, le destinataire, le nombre de points, la note de reconnaissance et le nom du programme. Cet article vous guidera à travers la création, la configuration et la gestion des webhooks pour synchroniser les données de reconnaissance de votre plateforme Awardco vers votre point de terminaison choisi.
- Cas d’utilisation des Webhooks
- Accéder au Créateur de Webhooks
- Créer un Webhook
- Gérer les Webhooks
- FAQ
Cas d’utilisation des Webhooks
Les webhooks permettent à votre organisation d’afficher des mises à jour de reconnaissance en temps réel sur des flux sociaux hors plateforme, comme un intranet d’entreprise.
Contrairement à la connexion via des appels API de flux, le processus est instantané avec les webhooks. Dès qu’une reconnaissance est soumise dans votre plateforme Awardco, le webhook est déclenché et les données de reconnaissance sont immédiatement envoyées à votre point de terminaison spécifié, permettant des mises à jour instantanées sur vos flux externes.
Accéder au Créateur de Webhooks
Pour commencer à créer et gérer des webhooks :
- Connectez-vous à votre plateforme de reconnaissance.
- Sur la page d’accueil, sélectionnez le bouton Admin en bas du menu de navigation gauche.
- Sélectionnez « Plateforme », puis « Intégrations », puis « Webhooks » dans le menu de navigation gauche.
Sur la page Webhooks, vous verrez la liste des webhooks existants. Pour en créer un nouveau, cliquez sur le bouton Créer un Webhook.
Créer un Webhook
Lorsque vous cliquez sur « Créer un Webhook », une fenêtre modale apparaît où vous pouvez configurer votre nouveau webhook. Voici une explication de chaque champ :
- Nom : Donnez un nom descriptif à votre webhook. Cela vous aidera à l’identifier plus tard, surtout si vous avez plusieurs webhooks.
- Événements déclencheurs : Ce menu déroulant contient actuellement une seule option : Reconnaissance terminée. Cela signifie que votre webhook s’activera chaque fois qu’une reconnaissance est envoyée avec succès dans Awardco. Nous sommes ouverts à ajouter d’autres types d’événements déclencheurs à l’avenir selon les demandes des clients.
- URL du point de terminaison : C’est l’URL où les données de reconnaissance seront envoyées. Vous êtes responsable de fournir cette URL. C’est le « lieu » avec lequel votre webhook communiquera.
- Clé secrète : Il s’agit d’une mesure de sécurité générée automatiquement. Lorsqu’une requête webhook est envoyée depuis Awardco, vous utiliserez cette clé secrète pour créer une signature. Cette signature est ensuite comparée à une signature envoyée par Awardco. Si elles correspondent, cela vérifie que les données proviennent réellement d’Awardco et non d’un tiers malveillant. Pour plus de détails techniques sur la manière de générer cette signature, consultez la section « Vérification du Webhook » dans notre documentation API.
- Adresses courriel des destinataires d’erreurs : En cas de problème avec la livraison des données de votre webhook, les journaux d’erreurs seront envoyés aux adresses courriel listées ici. Vous pouvez ajouter plusieurs adresses en les séparant par des virgules.
- Statut : Activez cette option sur Actif pour que les données d’événement soient livrées lorsque l’événement déclencheur se produit. La mettre sur Inactif mettra le webhook en pause.
- Effectuer un test : Cliquez sur ce bouton pour envoyer des données de reconnaissance factices à votre URL de point de terminaison spécifiée. Cela vous permet de vérifier que votre webhook est configuré correctement avant de le mettre en service avec des données réelles. N’oubliez pas de supprimer toute reconnaissance de test qui apparaît sur votre flux hors plateforme après avoir effectué un test.
Gérer les Webhooks
Une fois que vous avez créé un webhook, vous pouvez le gérer depuis la page principale des Webhooks. À côté de chaque webhook, vous trouverez un menu à trois points avec les options suivantes :
- Voir les détails : Cette option affiche des informations générales sur le webhook, y compris la possibilité de copier la clé secrète.
- Modifier : Cela vous ramène à la fenêtre modale de création de webhook, où vous pouvez modifier n’importe quel paramètre du webhook.
- Effectuer un test : Semblable au bouton « Effectuer un test » lors de la création, cela envoie des données factices à votre URL de point de terminaison pour assurer que le webhook fonctionne comme prévu.
- Mettre Inactif : Cela met le webhook en pause, l’empêchant d’être déclenché et d’envoyer des données.
- Mettre Actif : (Visible uniquement si le webhook est inactif) Cela réactive le webhook, lui permettant d’être déclenché à nouveau.
- Supprimer : Cela supprime définitivement le webhook.
FAQ
-
Q : Quelle est la différence entre les webhooks et les API ?
- R : Les API nécessitent généralement que vous fassiez des requêtes pour extraire des données. Les webhooks, en revanche, sont « pilotés par événements », ce qui signifie qu’ils poussent automatiquement les données vers votre point de terminaison spécifié dès qu’un événement particulier (comme l’envoi d’une reconnaissance) se produit. Cela rend les webhooks idéaux pour les mises à jour en temps réel.
-
Q : Puis-je obtenir des webhooks pour d’autres événements que « Reconnaissance terminée » ?
- R : Actuellement, « Reconnaissance terminée » est le seul événement déclencheur disponible. Nous envisageons d’ajouter d’autres types d’événements déclencheurs à l’avenir. Si vous avez un cas d’utilisation spécifique, veuillez contacter votre personne-ressource Awardco.
-
Q : Où puis-je trouver plus de documentation technique sur les webhooks ?
- R : Notre documentation API comprend une section dédiée aux webhooks, qui fournit plus de détails techniques, y compris des informations sur la manière de générer une signature à partir de votre clé secrète pour la vérification du webhook. En version bêta, cette page est accessible directement à l’adresse : https://api.awardco.com/api/webhooks
If you have any questions, please contact Awardco Admin Support.