Aller au contenu principal

Configurer les webhooks

Configurez les webhooks dans la Logto Console pour obtenir une intégration transparente et recevoir des notifications d'événements en temps réel pour votre application. Profitez d'une configuration facile, d'une sécurité renforcée et d'options pratiques de surveillance de la santé.

Créer un webhook​

Tout d'abord, créez un point de terminaison de webhook qui sera appelé par le Logto Agent. Ce point de terminaison doit être implémenté sur votre serveur et capable de recevoir des requêtes HTTP.

Pour créer un nouveau webhook dans la Logto Console, suivez ces étapes :

  1. Créer un webhook : Accédez à Console > Webhooks et cliquez sur le bouton "Créer un webhook".

  2. Nom : Fournissez un nom pour le webhook. Il est destiné à votre propre référence pour définir le scénario d'utilisation.

  3. URL du point de terminaison : Entrez l'Endpoint URL, qui est l'URL de votre serveur qui recevra les requêtes POST du webhook lorsque l'événement se produira. Pour des raisons de sécurité, l'URL doit être accessible publiquement via HTTPS et ne doit pas être une URL de localhost.

    remarque

    Votre serveur doit répondre aux requêtes de webhook Logto avec une réponse HTTP 200 ("OK") immédiatement après avoir reçu la requête pour notifier que la requête a été reçue.

    Attendre que le traitement logique de l'événement Webhook correspondant soit terminé avant de répondre pourrait entraîner un délai d'expiration du Webhook.

    Ne retournez aucune réponse autre que 200 au webhook Logto. Si une erreur se produit lors du traitement de l'événement, gérez-la sur votre propre serveur.

  4. Événement : Dans la fenêtre modale qui apparaît, sélectionnez les événements souhaités qui déclencheront ce webhook. Il est recommandé de choisir un plus petit nombre d'événements qui répondent à vos besoins pour éviter de surcharger la réception du serveur. Vous pouvez modifier les événements sélectionnés à tout moment après la création du webhook.

    Créer un webhook

  5. Désactiver / Réactiver : Par défaut, le webhook est activé immédiatement après sa création. Si vous souhaitez suspendre temporairement le webhook, vous pouvez le désactiver ou le réactiver en utilisant le menu "Trois points" situé dans le coin supérieur droit de l'en-tête après l'avoir créé.

Sécuriser le webhook​

Une fois que votre serveur est prêt à recevoir des requêtes de webhook, vous voudrez peut-être vous assurer qu'il peut gérer les requêtes en toute sécurité. Logto génère une signature pour chaque charge utile de requête de webhook, ce qui vous permet de vérifier que la requête provient de Logto.

Après avoir créé un nouveau webhook, vous avez des options pour renforcer sa sécurité :

  • Clé de signature : Logto génère une signature de hachage unique, connue sous le nom de Clé de Signature, pour chaque webhook. Vous pouvez inclure cette clé en tant qu'en-tête de requête dans votre implémentation de point de terminaison. Vérifier la clé de signature garantit que la charge utile du webhook provient de Logto et n'a pas été altérée par des sources non autorisées. Lisez sécuriser vos webhooks pour en savoir plus sur le code.
  • En-tête personnalisé : Vous avez la possibilité d'inclure des en-têtes personnalisés dans la charge utile du webhook pour fournir un contexte ou des métadonnées supplémentaires. Cette fonctionnalité vous permet d'ajouter des informations pertinentes qui peuvent aider à traiter efficacement les données du webhook.

En utilisant la Clé de Signature et en envisageant l'inclusion d'En-têtes Personnalisés, vous pouvez renforcer la sécurité de vos webhooks et garantir l'intégrité et l'authenticité des charges utiles reçues.

Tester le webhook​

Pour tester la connexion entre Logto et vos services, cliquez simplement sur le bouton "Envoyer une charge utile de test". Logto enverra alors une charge utile d'exemple pour chaque événement sélectionné à votre URL de point de terminaison. Ces requêtes de test contiennent des données anonymes et ne sont pas enregistrées dans l'historique des requêtes récentes.

Ce test garantit que votre webhook est correctement configuré pour recevoir et traiter les charges utiles de Logto. Il vous permet de valider l'intégration avant de déployer le webhook dans un environnement de production.

Surveiller l'état de santé du Webhook​

Logto fournit des outils pratiques pour surveiller l'état de santé de vos webhooks et enquêter en détail sur d'éventuels problèmes :

  • État de santé La liste des webhooks dans Logto affiche l'état de santé de chaque webhook, y compris le taux de réussite et le nombre total de requêtes effectuées au cours des dernières 24 heures. Ces informations vous donnent un aperçu des performances du webhook.
  • Journaux de requêtes indépendants Dans la section "Requêtes récentes" de chaque webhook, vous pouvez accéder aux journaux de requêtes des dernières 24 heures. Chaque requête est enregistrée individuellement, vous permettant de voir les détails de chaque requête et d'enquêter sur d'éventuelles erreurs ou anomalies.
  • Réessai automatique En cas d'échec de livraison (lorsque le statut de réponse du webhook est supérieur ou égal à 500), Logto réessaie automatiquement la livraison jusqu'à trois fois. Soyez assuré que plusieurs réessais de la même requête ne généreront qu'une seule entrée de journal, évitant ainsi les duplications inutiles.

En tirant parti de ces fonctionnalités de surveillance, vous pouvez suivre efficacement la santé de vos webhooks, examiner les journaux de requêtes et garantir la fiabilité et les performances de vos intégrations de webhook.