Créer un webhook de notification

Modifier en ligne

Les webhooks de notification sont des appels API externes qui permettent d'envoyer des données à un service tiers lorsque des événements spécifiques se produisent.

A propos de cette tâche

Vous pouvez configurer l' URL de la requête de l'API externe que vous souhaitez lancer et ajouter les en-têtes ou paramètres nécessaires au lancement de l' URL de la requête. Pour plus d'informations sur les données utiles des événements, consultez la section « Types d'événements et données utiles ».

Dans le fichier JSON de configuration du 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 interests propriété correspond à un critère, l'événement est envoyé à la destination du webhook. Les centres d'intérêt sont vérifiés dans l'ordre; par conséquent, dans les cas d'utilisation exigeants, placez 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 correspond ou non. Les clauses sont reliées par une AND opération, et ce n'est que si elles sont toutes satisfaites que l'intérêt est pris en compte. Une clause se compose de trois zones :

  • key
  • value
  • operation - Les valeurs valides sont include et exclude.
La clé correspond au nom d'une propriété JSON et sert à indiquer à quel endroit de l'événement il faut vérifier si cette clause correspond. Cette clé peut être utilisée pour évaluer des clés de niveau supérieur ou des clés situées dans l'objet de données d'un événement. Lorsqu'il fait référence à l'objet de données, on utilise la notation JSON avec le point, par exemple data.action. Cette valeur correspond à la valeur attendue du champ en cours de vérification. Cette opération indique si une correspondance avec cette clause entraîne l'inclusion ou l'exclusion de l'événement.

Par exemple, lorsque les événements d'authentification constituent le principal sujet d'intérêt, mais que vous souhaitez exclure les authentifications effectuées 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 donnent lieu à l'évaluation logique suivante :

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.
    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 : le message du client indique que le secret est stocké sous forme d'attribut. Client basic signifie que le secret est stocké dans l'en-tête.
    Jeton Web JSON (JWT)
    Indiquez la valeur de l'en-tête « HTTP », la sous-réclamation, la durée de validité maximale du JWT et l'algorithme de signature. Si vous le souhaitez, vous pouvez également définir un préfixe pour les valeurs d'en-tête JWT, ainsi que les clés d'en-tête JWT et les noms de revendications.
    Mutual TLS ( mTLS )
    Indiquez le nom du certificat MTLS.
  6. Facultatif : saisissez les en-têtes et les valeurs de votre choix.
  7. Facultatif : activer les messages non remis.
    La rubrique « Courriers non distribués » répertorie les notifications qui n'ont pas abouti.
    1. Cochez la case « Tenter automatiquement le rapprochement des messages non remis » et sélectionnez la fréquence à laquelle ce rapprochement doit être effectué.
      Vous pouvez choisir de renvoyer la notification toutes les 5, 15 ou 30 minutes.
  8. Cliquez sur Suivant.
  9. Définissez les abonnements aux événements pour votre webhook.
    Lorsqu'un des événements que vous avez définis 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 indiquer au moins un événement.
  10. Facultatif : cliquez sur « Événements prédéfinis ».
    1. Cochez la case correspondant à un ou 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 sélectionnez apparaissent dans le volet « Détails » sous la rubrique « Événements sélectionnés ».
    2. Cliquez sur « Ajouter ».
      Vous revenez à la page d'abonnement aux événements et ceux-ci apparaissent dans la section « Configuration des événements ».
  11. Facultatif : cliquez sur « Ajouter un événement personnalisé ».
    1. Donnez un nom à l'événement.
      Vous pouvez également ajouter une description de l'événement.
    2. Indiquez les centres d'intérêt qui déclenchent l'événement.
      Les événements sont constitués d'une paire « propriété-valeur » qui doit donner « vrai » pour déclencher l'événement.
    3. Indiquez si vous souhaitez inclure ou exclure les intérêts.
      Vous pouvez définir event_type authentication les paramètres « include » et user.type admin « exclude » pour déclencher le webhook à chaque événement d'authentification qui ne provient pas d'un administrateur.
    4. Facultatif : indiquez d'autres centres d'intérêt.
  12. Cliquez sur « Ajouter ».
    Vous revenez à la page d'abonnement à l'événement, et celui-ci apparaît dans la section « Configuration de l'événement ».
  13. Facultatif : ajoutez d'autres événements personnalisés.
  14. Cliquez sur Créer.
    Le webhook figure sur la page « Webhooks de notification » et s'affiche.
  15. Facultatif : Modifier les événements du webhook.
    1. Ajoutez d'autres événements personnalisés et prédéfinis.
    2. Modifier les événements
      1. Icône d'éditionSélectionnez l'événement que vous souhaitez modifier, puis cliquez sur l'icône en forme de crayon.
      2. Vous pouvez modifier le nom ou la description. Vous pouvez ajouter ou modifier vos centres d'intérêt.
      3. Cliquez sur « Mettre à jour ».
    3. Le signe de la soustraction à l'intérieur d'un cerclePour supprimer un événement, sélectionnez-le et cliquez sur l'icône « Supprimer ».
  16. Facultatif : modifiez les détails de la connexion.
    1. Sélectionnez « Détails de la connexion ».
    2. Modifiez tous les paramètres, à l'exception de « Objectif » et de la « Version d'intégration ».
    3. Testez la connexion.
    4. Consulter 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 ».