Enregistrer un événement webhook
L'enregistrement de webhook est le processus d'établissement d'une connexion entre des systèmes pour permettre l'échange d'informations en temps réel. Lorsque vous enregistrez un webhook, vous indiquez essentiellement à un système où envoyer les données lorsqu'un événement spécifique se produit dans un autre système.
Lorsque votre utilisateur active un flux qui contient votre carte d'événement webhook déployé, le flux d'aide à enregistrement est déclenché.
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.
Commencer cette tâche
-
Cliquez sur votre nouveau connecteur pour l'ouvrir dans le panneau principal.
-
Dans l'onglet Flux, créez un flux en cliquant sur + Nouveau flux.
-
Cliquez sur Ajouter un événement et, dans les choix Événements, sélectionnez Événement de webhook : enregistrement.
-
Dans la carte Enregistrement de webhook, définissez les entrées pour votre enregistrement de webhook. Vous pouvez fournir ces valeurs d'entrée de deux manières :
-
En tant que texte statique utilisé chaque fois que la carte d'événement webhook exécute le flux d'enregistrement.
-
En tant que valeurs facultatives transmises au flux d'enregistrement depuis la carte d'événement webhook. Lorsque vous ajoutez le flux enregistrement à une carte d'événement webhook, vous pouvez mapper les valeurs des options de l'événement webhook avec les entrées de cette carte. Cette deuxième option vous permet de réutiliser la même carte d'événement d'enregistrement pour plusieurs cartes d'événement webhook.
Remarque :L'URL d'événement est une URL générée automatiquement. Elle est créée lorsque l'utilisateur active son flux qui contient cet événement webhook.
-
-
Utilisez les cartes de fonction pour construire et appeler le service externe et enregistrer le webhook.
Vous pouvez maintenant référencer ce flux d'enregistrement dans une carte d'événement webhook.
Renvoyer la carte
La carte de renvoi comprend un objet Données d'enregistrement. Lorsque votre utilisateur désactive un flux qui contient un événement webhook, le flux de l'événement d'annulation d'enregistrement fait référence aux informations stockées dans cet objet pour supprimer l'enregistrement de webhook. Par exemple, il peut s'agir d'un objet simple possédant un identificateur unique :
{
"webhook_id": "99b50e15-8809-47f1"
}L'objet peut également consister en un point de terminaison API, en une URL ou en toute autre information renvoyée par le service qui est nécessaire pour supprimer l'enregistrement de webhook. Consultez Annuler l'enregistrement d'un événement webhook.
Ce champ ne peut pas être supprimé ou retiré, et aucun autre champ ne peut être défini sur la carte de retour.