La charge utile d'un webhook est la donnée qui est reçue d'un système externe par un webhook URL en webMethods Integration lorsqu'un événement se produit. Cette charge utile est généralement au format JSON et contient des paires clé-valeur qui représentent les détails de l'événement ou les données que vous souhaitez traiter.
A propos de cette tâche
La configuration de la charge utile permet de webMethods Integration comprendre la structure des données entrantes afin qu'elles puissent être correctement associées à des variables dans votre flux de travail. Vous pouvez ajouter une charge utile à un webhook en utilisant l'option webhook payload. La structure de la charge utile que vous ajoutez ici doit être similaire à celle que le webhook est censé recevoir à l'avenir. webMethods Integration utilise ces données pour afficher la sortie du webhook dans les actions suivantes de votre flux de travail.
Remarque :
- Cliquez sur Webhook payload and log data pour obtenir des informations sur la charge utile maximale de webhook et les données de journal prises en charge sur Amazon Web Services et Microsoft Azure.
- Les données du payload du webhook qui sont ajoutées dans le flux de travail source ne sont pas conservées lorsque le flux de travail est cloné, importé ou déployé. Vous devez reconfigurer les paramètres du webhook dans chaque flux de travail cloné, importé et déployé.
Procédure
- Pour configurer la charge utile du webhook, sélectionnez le déclencheur du webhook et cliquez sur Suivant.
Les options suivantes permettent d'ajouter la charge utile du webhook :
- Récupérer automatiquement la charge utile du Webhook
- Vous pouvez utiliser cette méthode pour envoyer des payloads de webhook en temps réel via n'importe quel outil prenant en charge l'envoi de requêtes HTTP ou un navigateur. Il offre la possibilité d'envoyer des données personnalisées en temps réel lorsque vous envoyez des requêtes au webhook. Vous pouvez utiliser n'importe quelle application qui prend en charge les appels API REST, comme Postman ou un navigateur.
- Ajouter manuellement la charge utile du Webhook
- Vous pouvez utiliser cette méthode pour ajouter manuellement les données de la charge utile du webhook. Cependant, vous devez vous assurer que la structure de la charge utile que vous ajoutez est similaire à celle que le webhook est censé recevoir à l'avenir. webMethods Integration utilise ces données pour afficher la sortie du webhook dans les actions suivantes de votre flux de travail.
- Procédez comme suit pour récupérer automatiquement la charge utile du webhook.
Remarque : si vous souhaitez ajouter manuellement la charge utile du webhook, ignorez cette étape et passez à l'étape 3.
- Copiez le webhook généré aléatoirement URL.
- Collez ce webhook URL dans n'importe quel fournisseur de webhook qui peut envoyer des requêtes POST.
- Saisissez les détails dans les en-têtes et le corps du message si nécessaire, puis cliquez sur le bouton Envoyer.
Remarque : seul le format JSON est pris en charge. Lorsque vous configurez la demande, fournissez le corps de la demande au format JSON et définissez le type de contenu sur JSON (Application/JSON).
- Retournez à la page de configuration du webhook sur webMethods Integration et cliquez sur Fetch pour récupérer les données payantes du webhook.
Les champs En-tête, Corps et Requête sont remplis automatiquement avec les données que vous avez envoyées.
- Cliquez sur Suivant.
- Procédez comme suit pour ajouter manuellement les données payantes du webhook
- Dans la page Webhook, saisissez les données de la charge utile dans les champs de texte, Headers, Body et Query, au format JSON.
- Cliquez sur Suivant.
Etape suivante
Une fois les données utiles configurées, vous pouvez définir une méthode d'authentification pour renforcer la sécurité du webhook.