Générer un flux d'événement webhook

Workflows Okta vous permet de générer des cartes d'événement qui prennent en charge un framework webhook. Cela permet de fournir une réponse quasiment en temps réel aux événements survenant sur un système distant. La génération d'un événement de webhook dépend des fonctionnalités offertes par l'API de service à distance et de l'objectif de la carte d'événement.

Vous pouvez utiliser les flux d'événements webhook pour générer des cartes pour votre connecteur qui se déclenchent en fonction d'événements tels que la création utilisateur, la suppression de fichiers ou les rapports d'activité suspecte.

Pour en savoir plus sur le fonctionnement des webhooks, consultez Événements webhook.

Avant de commencer

  • Vous devez être un super administrateur avec accès à Workflows Okta.

  • Si vous n'avez pas encore créé de connecteur, suivez les étapes ci-dessous pour en créer un :

    • Depuis Okta Workflows Console, ouvrez le lien correspondant à la console Connector Builder.

    • Dans Connector Builder, cliquez sur l'icône pour créer un connecteur. Donnez à votre nouveau connecteur un nom unique et une description utile.

  • Assurez-vous que le connecteur dispose des éléments de base et d'authentification fournis par les tâches de la section Débuter rapidement avec les éléments de base.

Procédure

  1. Cliquez sur votre nouveau connecteur pour l'ouvrir dans le panneau principal.

  2. Dans l'onglet Flux, créez un flux en cliquant sur + Nouveau flux.

  3. Cliquez sur Ajouter un événement et, dans les choix Événements, sélectionnez Événement webhook.

  4. Cliquez sur Ajouter des options pour ajouter toutes les options que vous souhaitez déclarer pour la carte Événement webhook.

  5. Cliquez sur Configurer dans la section Enregistrement de webhook pour ouvrir la boîte de dialogue enregistrement de webhook.

  6. Dans la boîte de dialogue Enregistrement, cliquez sur Choisir le flux pour sélectionner les flux d'aide à l'enregistrement et à l'annulation de l'enregistrement pour l'événement webhook. Si aucun flux d'aide n'existe, vous pouvez cliquer sur Créer un nouveau flux.

    • Flux d'enregistrement

      Lorsque votre utilisateur active un flux qui contient votre carte d'événement webhook déployé, le flux d'aide à enregistrement est déclenché.

      Le flux enregistrement enregistre l'URL d'événement unique dans le service externe pour le flux de votre utilisateur, afin que le service sache où envoyer la charge utile de webhook.

      Après avoir sélectionné un flux d'aide à l'enregistrement, vous pouvez mapper des champs de saisie pour y accéder en utilisant les champs d'option présents sur votre carte d'événement webhook. Cela vous permet d'utiliser le même flux d'aide à l'enregistrement pour plusieurs cartes d'événement webhook en transmettant une option différente pour chaque carte webhook.

      Le flux d'aide à l'enregistrement comprend une carte de retour avec un champ d'objet appelé Données d'enregistrement. Cet objet est utilisé pour stocker toute référence nécessaire lorsque le flux de désenregistrement s'exécute.

      Consultez Enregistrer un événement webhook.

    • Flux d'annulation de l'enregistrement

      De même que le flux enregistrement, lorsque votre utilisateur désactive un flux contenant la carte d'événement webhook déployée, le flux d'aide à l'annulation de l'enregistrement est déclenché.

      Toute information définie à partir du flux enregistrement à l'aide de la sortie Données d'enregistrement est disponible en tant qu'entrée pour la carte d'événement Flux de désenregistrement.

      Après avoir sélectionné un flux d'aide à l'annulation de l'enregistrement, vous pouvez mapper les champs de saisie pour y accéder à l'aide des champs d'option de votre carte d'événement de webhook. Comme pour un flux d'aide à l'enregistrement, cela vous permet d'utiliser le même flux d'aide à l'annulation de l'enregistrement pour plusieurs cartes d'événement webhook.

      Le flux d'aide à l'annulation de l'enregistrement n'inclut pas de carte de retour.

      Consultez Annuler l'enregistrement d'un événement webhook.

    • Cliquez sur Appliquer pour confirmer vos flux d'aide à l'enregistrement et à l'annulation de l'enregistrement et leurs mappages d'entrée. Cliquez sur l'icône de la corbeille si vous devez supprimer un flux d'aide à l'enregistrement ou à l'annulation de l'enregistrement sélectionné.

  7. Cliquez sur Ajouter des sorties pour configurer la carte Sorties de retour pour le flux d'événement webhook.

  8. Dans la boîte de dialogue Options, vous pouvez spécifier les sorties que le webhook doit renvoyer. Cliquez sur Ajouter un groupe pour créer un groupe de sortie.

    1. Activez le mode Activer le mode Exécution si la charge utile webhook renvoie une liste d'enregistrements et que vous souhaitez spécifier le mode d'exécution pour tous les flux qui utilisent cette carte d'événement webhook. Consultez Activer le mode exécution pour les webhooks.

    2. Dans le volet Groupe de sorties statiques, indiquez un nom de groupe pour cet ensemble de sorties. Pour chaque champ que vous souhaitez renvoyer en tant que sortie, fournissez une étiquette et sélectionnez un type de champ et un type de données dans les menus déroulants. La carte d'aperçu vous montre comment la carte de retour apparaît.

    3. Cliquez sur Ajouter un groupe pour ajouter d'autres groupes de sortie.

  9. Cliquez sur Appliquer pour enregistrer les modifications apportées à votre carte Sorties de retour.

  10. Cliquez sur le bouton Enregistrer dans la barre d'outils et nommez le flux.

Étapes suivantes

Problèmes connus et limitations pour les flux d'événements webhook

Tester vos flux

Déployer vos flux