Les webhooks notifient des services externes tels que des clients de chat ou d'autres API externes d'événements. Un webhook peut configurer une URL lorsqu'un événement spécifique se produit.
Phrase Orchestrator fournit un service qui surveille et traite les notifications provenant de systèmes tiers. Ce service permet aux utilisateurs de connecter leurs flux de travaux à une grande variété de systèmes externes prenant en charge les requêtes HTTP.
Les utilisateurs peuvent créer un nouveau déclencheur pour les webhooks entrants à partir d'événements externes avec le système générant automatiquement une URL de webhook unique avec une clé API pour la configuration du webhook tiers. L'URL de webhook générée est unique et directement associée au compte et au flux de travaux de l'utilisateur, ce qui signifie que chaque webhook est lié à un seul flux de travaux.
Configurer le webhook entrant
Pour configurer un webhook entrant, suivez ces étapes :
-
Faites glisser et déposez un déclencheur dans un flux de travaux.
Le déclencheur apparaît dans le flux de travaux.
-
Cliquez sur le déclencheur pour ouvrir l'onglet .
-
Sélectionnez l'onglet .
-
Copier l'.
Cette URL doit être considérée comme secrète et ne pas être partagée. En cas de partage accidentel, cliquez sur Regenerate pour en créer un nouveau et invalider l'existant.
-
Pour envoyer une charge utile avec des données à utiliser dans les flux de travaux, fournissez le schéma de cette charge utile.
-
Pour fournir un schéma, cliquez sur Edit webhook .
-
Sélectionnez un :
Les schémas JSON sont une norme pour définir des charges utiles JSON. Si un service existant qui les utilise, ou un service externe pour se connecter à Orchestrator en fournit un, copiez-le tel quel.
-
JSON
Fournissez un exemple de charge utile JSON pour une configuration plus simple, permettant de tester le webhook sans définir de règles exactes.
-
JSON Schema
Définissez précisément la structure, les types de données et les règles de validation pour les données JSON.
-
-
Cliquer sur Save payload schema .
Un aperçu de la structure de données attendue pour le déclencheur de webhook est affiché.
-
-
Si nécessaire, ouvrez l'onglet pour ajouter des filtres au déclencheur.
-
Pour déclencher un flux de travaux une fois qu'il a été publié, envoyez une requête POST à l'URL du webhook. Pour les flux de travaux qui n'ont pas de schéma configuré, le corps doit être vide. Si un schéma configuré est appliqué, la charge utile doit correspondre au schéma.
Les utilisateurs peuvent configurer des flux de travaux qui non seulement reçoivent des données mais envoient également des mises à jour aux systèmes externes automatiquement. L'action de webhook sortant permet aux utilisateurs de déclencher automatiquement des actions spécifiques dans des systèmes externes.
Les webhooks dans d'autres services peuvent être déclenchés via l'action Envoyer une requête HTTP.
Configurer un webhook sortant
Pour configurer un webhook sortant, suivez ces étapes :