Aller au contenu principal
Version: Next

Introduction aux Webhooks

Les webhooks vous permettent de recevoir des notifications en temps réel lorsque des événements spécifiques se produisent sur la plateforme Beedeez. Au lieu d'interroger répétitivement notre API pour détecter les changements, les webhooks poussent les données vers votre application au moment où les événements se produisent, rendant votre intégration plus efficace et réactive.

Qu'est-ce qu'un Webhook ?

Les webhooks sont des callbacks HTTP qui envoient des notifications d'événements vers l'URL que vous avez configurée. Lorsqu'un événement se produit dans Beedeez (comme l'obtention ou l'expiration d'un certificat), nous envoyons une requête HTTP POST vers l'URL de votre webhook avec les données relatives à cet événement.

Comment Fonctionnent les Webhooks

  1. Configuration : Vous configurez vos webhooks dans le back office Beedeez en définissant :

    • L'URL où vous souhaitez recevoir les notifications
    • Les types d'événements auxquels vous souhaitez vous abonner
    • La méthode d'authentification pour sécuriser le webhook
    • Les en-têtes personnalisés et le délai d'expiration
  2. Déclenchement : Lorsqu'un événement auquel vous êtes abonné se produit sur la plateforme (ex : un utilisateur obtient un certificat), Beedeez le détecte.

  3. Envoi : Beedeez envoie une requête HTTP POST vers votre URL configurée avec un payload JSON contenant les détails de l'événement.

  4. Réception : Votre serveur reçoit le webhook, traite les données et retourne un code de statut HTTP 2xx pour confirmer la réception.

  5. Réessais : Si votre serveur ne répond pas correctement, Beedeez réessaie automatiquement l'envoi du webhook avec un délai exponentiel croissant.

Avantages de l'Utilisation des Webhooks

  • Mises à Jour en Temps Réel : Recevez des notifications instantanément lorsque des événements se produisent
  • Réduction des Appels API : Plus besoin d'interroger l'API de manière répétée pour détecter les changements
  • Intégration Efficace : Construisez des workflows événementiels qui réagissent aux changements de la plateforme
  • Évolutif : Gérez de gros volumes d'événements sans surcharger vos systèmes

Cas d'Usage

Les cas d'usage courants pour les webhooks incluent :

  • Gestion des Certificats : Notifier votre système RH lorsque des employés obtiennent des certifications
  • Analytiques d'Apprentissage : Suivre l'obtention des certificats et la progression dans votre entrepôt de données
  • Synchronisation des Utilisateurs : Maintenir les données utilisateur synchronisées entre Beedeez et vos systèmes
  • Workflows Automatisés : Déclencher des actions dans d'autres systèmes en fonction des événements d'apprentissage
  • Rapports de Conformité : Générer des rapports lorsque des certificats expirent ou doivent être renouvelés

Pour Commencer

Pour commencer à utiliser les webhooks :

  1. Lisez le Guide de Configuration pour apprendre à configurer vos webhooks
  2. Consultez la Référence des Types d'Événements pour découvrir les événements disponibles
  3. Comprenez les Options d'Authentification pour sécuriser vos webhooks
  4. Consultez les Exemples de Payloads pour voir les données que vous recevrez

Considérations Importantes

  • Sécurité : Utilisez toujours HTTPS et implémentez une authentification
  • Idempotence : Concevez votre gestionnaire pour qu'il puisse recevoir le même événement plusieurs fois sans effet de bord
  • Temps de Réponse : Répondez rapidement (sous 5 secondes) pour éviter les timeouts
  • Gestion des Erreurs : Retournez des codes de statut HTTP appropriés pour contrôler les réessais
  • Tests : Testez minutieusement votre webhook avant de l'activer en production

Support

Si vous avez besoin d'aide avec les webhooks, veuillez contacter notre équipe de support.