Création d'un webhook de notification

Modifier en ligne

Les webhooks de notification sont des appels d'API externes que vous utilisez pour envoyer des données à un tiers lorsque des événements spécifiques se produisent.

A propos de cette tâche

Vous pouvez configurer l' URL demande de l'API externe que vous souhaitez lancer et ajouter tous les en-têtes ou paramètres nécessaires au lancement de l' URL demande. Pour plus d'informations sur les charges utiles des événements, consultez Types d'événements et charges utiles.

Dans le JSON de configuration de webhook, il existe une propriété notification . Cette propriété est un objet JSON imbriqué qui contient toutes les options de configuration spécifiques aux notifications. La propriété interests est définie dans cet objet notification. Lorsqu'un événement est émis, il est vérifié par rapport à chaque élément de la propriété interests. Si un élément de la propriété interests est évalué à une correspondance, l'événement est envoyé à la destination de webhook. Les centres d'intérêt sont vérifiés dans l'ordre, donc dans les cas d'utilisation à haute performance, mettez la correspondance la plus large en premier.

Un intérêt se compose de deux zones, d'une name conviviale et d'une liste de clauses. Ces clauses déterminent si l'intérêt est une correspondance ou non. Les clauses sont jointes avec une opération AND et seulement si elles correspondent toutes à l'intérêt est satisfait. Une clause se compose de trois zones :

  • key
  • value
  • operation -les valeurs valides sont include et exclude.
La clé est un nom de propriété JSON et est utilisée pour indiquer où dans l'événement pour déterminer si cette clause correspond. La clé peut être utilisée pour évaluer des clés de niveau supérieur ou des clés dans l'objet de données d'un événement. Lorsqu'il fait référence à l'objet de données, la notation par point JSON est utilisée, par exemple data.action. La valeur est la valeur attendue de la zone en cours d'inspection. L'opération indique si une correspondance sur cette clause entraîne l'inclusion ou l'exclusion de l'événement.

Par exemple, lorsque les événements d'authentification sont l'intérêt principal, mais que vous souhaitez filtrer les authentifications qui se produisent via la fédération, utilisez les clauses suivantes:

  • Key: event_type, Value: authentication, Operation: include
  • Key: data.subtype, Value: federation, Operation: exclude

Ces clauses deviennent l'évaluation logique:

event_type EST authentication ET data.subtype N'EST PAS federation.

Pour plus d'informations, consultez la section Webhooks de notification.

Procédure

  1. Accédez à Intégrations > Webhooks de notification.
  2. Cliquez sur Créer un webhook.
  3. Indiquez un nom pour le webhook.
    Vous pouvez également indiquer un propriétaire et des informations de contact par courrier électronique.
  4. Indiquez une ou plusieurs URL de demande pour l'API.
  5. Sélectionnez le type d'authentification.
    Basique
    Indiquez le nom d'utilisateur et le mot de passe.
    En-tête
    Indiquez le nom d'en-tête et le secret d'authentification. Si le secret est sensible à la casse, cochez la case Sensible.
    Aucune
    Aucune information d'authentification n'est requise.
    protocole d"autorisation OAuth
    Spécifiez le noeud final de jeton, indiquez si le secret du client est de type post ou basic, entrez l'ID client et le secret.
    Remarque: La publication du client indique que le secret est stocké en tant qu'attribut. Client basic signifie que le secret est stocké dans l'en-tête.
    Jeton Web JSON (JWT)
    Spécifiez la valeur de l'en-tête HTTP, la sous-revendication, la durée de vie maximale du JWT et l'algorithme de signature. Si vous le souhaitez, vous pouvez également spécifier un préfixe de valeur d'en-tête JWT, des clés d'en-tête JWT et des noms de réclamation.
    TLS mutuel (mTLS)
    Indiquez le label de certificat MTLS.
  6. Facultatif : entrez les en-têtes et valeurs personnalisés.
  7. Facultatif : activer les lettres mortes.
    La fonction des lettres mortes enregistre les notifications d'échec.
    1. Activez l'option Tentative automatique de synchronisation des rebut et sélectionnez l'intervalle entre les tentatives de synchronisation.
      Vous pouvez indiquer de renvoyer la notification toutes les 5, 15 ou 30 minutes.
  8. Cliquez sur Suivant.
  9. Indiquez les abonnements aux événements pour votre webhook.
    Lorsque l'un des événements que vous spécifiez se produit, une notification est déclenchée pour le webhook. Sélectionnez un événement prédéfini ou ajoutez un événement personnalisé. Vous devez spécifier au moins un événement.
  10. Facultatif : cliquez sur Événements prédéfinis.
    1. Cochez la case d'un ou de plusieurs événements prédéfinis.
      • Tous les événements d'authentification
      • Evénements d'échec d'authentification
      • Profil utilisateur modifié
      • Profil utilisateur créé
      Les événements que vous choisissez sont répertoriés dans le panneau Détails pour les événements sélectionnés.
    2. Cliquez sur Ajouter.
      Vous revenez à la page Abonnement à un événement et les événements sont répertoriés dans la section Configuration d'événement .
  11. Facultatif : cliquez sur Ajouter un événement personnalisé.
    1. Indiquez un nom pour l'événement.
      Vous pouvez également spécifier une description de l'événement.
    2. Indiquez les centres d'intérêt qui déclenchent l'événement.
      Les événements sont une propriété et une paire de valeurs qui doivent être évaluées comme vraies pour déclencher l'événement.
    3. Indiquez si vous souhaitez inclure ou exclure l'intérêt.
      Vous pouvez spécifier event_type authentication include et user.type admin exclude pour déclencher le webhook sur chaque événement d'authentification qui n'est ni d'origine ni d'administration.
    4. Facultatif : précisez d'autres centres d'intérêt.
  12. Cliquez sur Ajouter.
    Vous revenez à la page Abonnement à un événement et l'événement est répertorié dans la section Configuration d'événement .
  13. Facultatif : ajoutez d'autres événements personnalisés.
  14. Cliquez sur Créer.
    Le webhook est répertorié sur la page Notification webhooks et le webhook s'affiche.
  15. Facultatif : modifiez les événements du webhook.
    1. Ajoutez d'autres événements personnalisés et prédéfinis.
    2. Editer les événements
      1. Sélectionnez l'événement que vous souhaitez modifier et cliquez sur l'icône en forme de Icône d'édition crayon.
      2. Vous pouvez modifier le nom ou la description. Vous pouvez ajouter ou modifier les centres d'intérêt.
      3. Cliquez sur Mettre à jour.
    3. Pour supprimer un événement, sélectionnez-le et cliquez sur l'icône Signe de soustraction à l'intérieur d'un cercleSupprimer.
  16. Facultatif : modifiez les détails de la connexion.
    1. Sélectionnez Détails de la connexion.
    2. Modifiez tous les paramètres sauf Purpose et Integration version.
    3. Testez la connexion.
    4. Affichez l'état de santé.
    5. Supprimez le webhook.
  17. Si vous avez apporté des modifications, cliquez sur Enregistrer les modifications.
  18. Cliquez sur Webhooks de notification pour revenir à la page Webhooks de notification .