Aller au contenu principal

Configurer les webhooks

Configurez les webhooks dans la Console Logto 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 l'état de santé.

Créer un webhook​

Commencez par créer un point de terminaison webhook qui sera appelé par l'Agent Logto. 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 Console Logto, suivez ces étapes :

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

  2. Nom : Donnez un nom au webhook. Il s'agit d'une référence personnelle pour définir le scénario d'utilisation.

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

    remarque:

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

    Attendre la fin du traitement logique de l'événement Webhook correspondant avant de répondre peut entraîner un dépassement de délai 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 qui s'affiche, sélectionnez les événements souhaités qui déclencheront ce webhook. Il est recommandé de choisir un nombre restreint d'événements correspondant à vos besoins pour éviter de surcharger la réception côté 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 à l'aide du menu "Trois points" situé dans le coin supérieur droit de l'en-tête après sa création.

Sécuriser le webhook​

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

Après avoir créé un nouveau webhook, vous disposez d'options pour renforcer sa sécurité :

  • Clé de signature : Logto génère une signature de hachage unique, appelée Clé de signature, pour chaque webhook. Vous pouvez inclure cette clé comme en-tête de requête dans l'implémentation de votre point de terminaison. La vérification de 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 faciliter le traitement efficace des données du webhook.

En utilisant la Clé de signature et en envisageant l'ajout 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, il vous suffit de cliquer 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 en 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 examiner en détail tout problème potentiel :

  • É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 24 dernières 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 24 dernières heures. Chaque requête est enregistrée individuellement, ce qui vous permet de consulter les détails de chaque requête et d'examiner d'éventuelles erreurs ou anomalies.
  • Répétition automatique En cas d'échec de la livraison (lorsque le statut de réponse du webhook est supérieur ou égal à 500), Logto retente automatiquement la livraison jusqu'à trois fois. Soyez assuré que plusieurs tentatives de la même requête ne génèrent qu'une seule entrée dans le journal, évitant ainsi toute duplication inutile. Toutes les tentatives de livraison d'une même requête portent le même deliveryId dans la charge utile, de sorte que votre point de terminaison peut ignorer une livraison déjà traitée.

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