Webhooks

Un webhook peut être un webhook standard ou un webhook flexible. Avec un webhook standard, les champs de requête et de réponse sont définis par les agents de conversation (Dialogflow CX). Avec un webhook flexible, vous définissez les champs de requête et de réponse.

Webhooks standards

Avec les webhooks standards, vous utilisez des messages de requête et de réponse définis par les agents de conversation (Dialogflow CX). Le message de requête fournit de nombreuses informations sur la session. Par exemple, la page active actuelle, l'intent correspondant récent, les valeurs des paramètres de session et les réponses définies par l'agent sont tous inclus.

Requête de webhook standard

Lorsqu'un fulfillment avec un webhook est appelé, les agents conversationnels (Dialogflow CX) envoient une requête de webhook POST HTTPS à votre service de webhook. Le corps de cette requête est un objet JSON WebhookRequest contenant des informations sur la session.

Certaines intégrations renseignent le champ WebhookRequest.payload avec des informations supplémentaires. Par exemple, l'intégration de la passerelle de téléphonie Dialogflow CX fournit l'ID de l'appelant de l'utilisateur final.

Pour en savoir plus, consultez la documentation de référence sur WebhookRequest(V3) ou WebhookRequest(V3Beta1).

Réponse webhook standard

Une fois que votre service webhook a reçu une requête de webhook, il doit envoyer une réponse de webhook. Les limites suivantes s'appliquent à votre réponse :

• La réponse doit se produire dans un délai d'expiration que vous configurez lors de la création de la ressource de webhook, sinon la requête expirera.
• La taille de la réponse doit être inférieure ou égale à 64 Kio.

Pour en savoir plus, consultez la documentation de référence sur WebhookResponse(V3) ou WebhookResponse(V3Beta1).

Paramètres des ressources webhook standards

Vous trouverez ci-dessous la description des paramètres de ressource webhook pour les webhooks standards:

Webhooks flexibles

Avec les webhooks flexibles, vous définissez la méthode HTTP de la requête, les paramètres d'URL de la requête et les champs des messages de requête et de réponse. La requête ne peut fournir que des valeurs de paramètre sélectionnées, et la réponse ne peut fournir que des valeurs de forçage de paramètre. Cette limitation est en fait bénéfique, car elle simplifie l'interface entre l'agent et le webhook. Il est rarement nécessaire de communiquer autre chose que les valeurs des paramètres de session entre un agent et un webhook. Cela simplifie également l'implémentation de votre webhook, car les messages de requête et de réponse ne contiennent que ce dont vous avez besoin, et vous pouvez fournir des messages de webhook uniques pour différents scénarios.

Requête de webhook flexible

Lorsque vous créez la ressource de webhook pour votre agent, vous pouvez spécifier les éléments suivants pour les requêtes de webhook:

• Méthode HTTP utilisée pour les requêtes webhook envoyées à votre service de webhook.
• Valeurs de paramètre de session que les agents conversationnels (Dialogflow CX) doivent envoyer à votre service de webhook à l'aide de l'URL.
• Si vous choisissez POST, PUT ou PATCH comme méthode, vous pouvez spécifier les valeurs de paramètre de session que les agents conversationnels (Dialogflow CX) doivent envoyer à votre service webhook via le corps JSON de la requête.

Pour envoyer des valeurs de paramètres de session à l'aide de l'URL de la requête ou du corps JSON, utilisez des références de paramètres comme vous le feriez normalement. Vous n'avez pas besoin d'échapper la référence de paramètre en URL et vous ne devez pas l'encapsuler entre guillemets. Au moment de l'exécution, les agents de conversation (Dialogflow CX) échapperont la valeur du paramètre au format URL si nécessaire. Une liste ou une valeur composite sera fournie au format JSON.

Lorsque vous utilisez une référence de paramètre dans le corps JSON, vous devez l'encapsuler entre guillemets, quel que soit le type du paramètre. Si le paramètre est en fait une valeur scalaire, une liste ou une valeur composite numérique, les agents conversationnels (Dialogflow CX) suppriment les guillemets lors de l'envoi de la requête au moment de l'exécution pour préserver le type de données du paramètre. Les types scalaires de chaîne resteront entre guillemets. Si une valeur scalaire, une liste ou une valeur composite numérique est référencée dans une valeur de chaîne (par exemple, "Il s'agit d'un nombre : $session.params.size"), le paramètre est traité comme une chaîne ("Il s'agit d'un nombre : 3").

Par exemple, vous pouvez fournir les valeurs des paramètres de session fruit et size à l'URL de la requête comme suit:

https://your-webhook-service.com/handler?f=$session.params.fruit&s=$session.params.size

Et au corps de la requête JSON comme suit:

{
  "fruitParameter": "$session.params.fruit",
  "sizeParameter": "$session.params.size"
}

Réponse webhook flexible

Lorsque vous créez la ressource webhook pour votre agent, vous pouvez spécifier des paramètres de session que les agents conversationnels (Dialogflow CX) doivent définir sur des champs spécifiques de la réponse du webhook au moment de l'exécution.

Les limites suivantes s'appliquent à votre réponse :

• La réponse doit se produire dans un délai d'expiration que vous configurez lors de la création de la ressource de webhook, sinon la requête expirera.
• La taille de la réponse doit être inférieure ou égale à 64 Kio.

Utilisez le format suivant pour spécifier un champ scalaire, une liste ou un champ composite:

$.fully.qualified.path.to.field

Par exemple, examinons la réponse JSON suivante:

{
  "routes" : [
    {
      "legs" : [
        {
          "distance" : {
            "text" : "2,064 mi",
            "value" : 3321004
          }
        }
      ]
    }
  ]
}

Pour spécifier le champ "value", utilisez ce qui suit:

$.routes[0].legs[0].distance.value

Paramètres flexibles des ressources webhook

Vous trouverez ci-dessous la description des paramètres de ressources webhook pour les webhook flexibles:

Utiliser un modèle personnalisé prédéfini

Dialogflow propose des modèles personnalisés prédéfinis que vous pouvez utiliser pour intégrer des webhooks flexibles au CRM Salesforce.

1. Dans l'onglet Gérer, cliquez sur Webhooks, puis sur + Créer.

2. Sous Sous-type, sélectionnez Flexible.

3. Cliquez sur Configurer à l'aide d'un modèle prédéfini pour activer cette fonctionnalité.

4. Dans le menu déroulant Type d'intégration, sélectionnez Salesforce.

5. Dans le menu déroulant Nom de l'API, sélectionnez un nom d'API. Le modèle remplit automatiquement le formulaire de webhook en fonction du nom de l'API que vous choisissez.

   1. Vous pouvez configurer manuellement les champs suivants, le cas échéant, en fonction de vos paramètres:

      • URL du webhook
      • Méthode
      • Corps JSON de la requête
      • Configuration de la réponse

   2. Les champs OAuth obligatoires sont mis en surbrillance dans la section Authentification.

6. Cliquez sur Enregistrer pour créer le webhook.

Conditions requises pour le service de webhook

Votre service de webhook doit remplir les conditions suivantes :

• Il doit gérer les requêtes HTTPS. Le protocole HTTP n'est pas compatible. Si vous hébergez votre service de webhook sur Google Cloud Platform à l'aide d'une solution de calcul ou de calcul sans serveur, consultez la documentation produit pour la diffusion avec HTTPS. Pour connaître les autres options d'hébergement, consultez la page Obtenir un certificat SSL pour votre domaine.
• Son URL pour les requêtes doit être accessible publiquement, sauf si elle est hébergée en tant que fonction Cloud Run ou si elle est accessible en tant que webhook Service Directory.
• Il doit gérer les requêtes et les réponses comme décrit dans la section Webhook standard ou Webhook flexible.
• Si votre agent n'intègre pas l'accès au réseau privé de l'annuaire des services, les appels webhook sont considérés comme extérieurs au périmètre de service et sont bloqués lors de l'activation de VPC Service Controls. L'annuaire des services accepte les points de terminaison limités. Pour en savoir plus, consultez l'annuaire des services.

Authentification

Il est important de sécuriser votre service de webhook, de sorte que vous seul ou votre agent Conversational Agents (Dialogflow CX) soyez autorisé à effectuer des requêtes. Cette configuration se fait lors de la création d'une ressource webhook. Les agents de conversation (Dialogflow CX) sont compatibles avec les mécanismes d'authentification suivants:

OAuth tiers

Les agents conversationnels (Dialogflow CX) peuvent collecter un jeton d'accès auprès d'un fournisseur OAuth tiers et l'ajouter à l'en-tête HTTP d'autorisation lorsqu'ils envoient leurs requêtes webhook.

Vous trouverez ci-dessous la description des paramètres de ressources pour OAuth tiers:

Les requêtes envoyées à l'URL du point de terminaison OAuth pour recevoir un jeton n'incluent pas les en-têtes de requête personnalisés configurés pour la requête webhook. Vous pouvez transmettre des informations personnalisées au serveur OAuth en tant que paramètres dans la chaîne de requête de l'URL du point de terminaison OAuth.

Jetons d'accès de l'agent de service

Les agents de conversation (Dialogflow CX) peuvent générer un jeton d'ID ou un jeton d'accès à l'aide de l'agent de service des agents de conversation (Dialogflow CX).

Le jeton est ajouté dans l'en-tête HTTP d'autorisation lorsque les agents conversationnels (Dialogflow CX) appellent un webhook.

Jeton d'ID

Un jeton d'ID peut être utilisé pour accéder aux fonctions et services Cloud Run après avoir accordé le rôle Demandeur à

service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com

L'audience utilisée pour générer le jeton d'ID correspond à l'URL complète du webhook, à l'exception des paramètres de requête. Si vous utilisez Cloud Run, assurez-vous que cette URL est compatible avec les audiences Cloud Run. Par exemple, si l'URL du webhook est

https://myproject.cloudfunctions.net/my-function/method1?query=value

L'URL suivante doit figurer dans les audiences personnalisées.

https://myproject.cloudfunctions.net/my-function/method1

Tout webhook peut également valider le jeton à l'aide de bibliothèques clientes Google ou de bibliothèques Open Source telles que github.com/googleapis/google-auth-library-nodejs.

Jeton d'accès

Un jeton d'accès peut être utilisé pour accéder à d'autres API Google Cloud une fois que vous avez accordé les rôles requis à

service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com

Validation des certificats HTTPS

Les agents de conversation (Dialogflow CX) utilisent par défaut le trust store par défaut de Google pour valider les certificats HTTPS. Si vous avez l'intention d'utiliser des certificats non reconnus par le magasin de confiance par défaut de Google pour votre serveur HTTPS, tels que des certificats autosignés ou des certificats racines personnalisés, consultez la pageCertificats CA personnalisés.

Webhooks spécifiques à l'environnement

Si vous utilisez des environnements pour isoler les systèmes de production des systèmes de développement (recommandé), vous pouvez configurer vos webhooks pour qu'ils soient spécifiques à l'environnement. Pour chaque ressource webhook que vous définissez, vous pouvez fournir une URL et des paramètres d'authentification uniques pour chaque environnement que vous avez défini pour l'agent.

Vous pouvez ainsi développer et tester de manière sécurisée les mises à jour de votre code de webhook avant de les déployer en production.

Créer ou modifier des ressources de webhook

Une fois que vous avez un service de webhook en cours d'exécution, vous devez créer une ressource de webhook contenant les informations de connectivité et d'authentification. Une fois la ressource webhook créée, vous pouvez également modifier ses paramètres à tout moment.

Pour créer ou modifier une ressource de webhook:

Erreurs de webhook

Si votre service de webhook rencontre une erreur lors du traitement d'une requête de webhook, votre code de webhook doit renvoyer l'un des codes d'état HTTP suivants :

• 400 Requête incorrecte
• 401 Opération non autorisée
• 403 Interdit
• 404 Introuvable
• 500 Panne du serveur
• 503 Service indisponible

Dans les situations d'erreur suivantes, les agents de conversation (Dialogflow CX) appellent une erreur de webhook ou un événement intégré lié à un délai avant expiration, et continuent le traitement comme d'habitude:

• Expiration du délai de réponse
• Code d'état d'erreur reçu
• Réponse non valide
• Service de webhook non disponible

En outre, si l'appel de service de webhook a été déclenché par un appel d'API de détection d'intent, le champ queryResult.webhookStatuses de la réponse de détection d'intent contient les informations d'état du webhook.

Nouvelles tentatives automatiques

Les agents de conversation (Dialogflow CX) incluent des mécanismes internes qui réessayent automatiquement en cas d'erreurs de webhook spécifiques pour améliorer la robustesse. Seules les erreurs non terminales sont réessayées (par exemple, les erreurs de délai avant expiration ou de connexion).

Pour réduire la probabilité d'appels en double:

• Définissez des seuils de délai avant expiration plus longs pour les webhooks.
• Assurez-vous que la logique des webhooks est idempotente ou dédupliquez les données.

Utiliser Cloud Run Functions

Les agents conversationnels (Dialogflow CX) s'intègrent aux fonctions Cloud Run pour vous permettre de créer facilement un webhook sécurisé sans serveur. Si vous créez une fonction qui réside dans le même projet que votre agent, il vous suffit de sélectionner Authentification de l'agent de service -> Jeton d'ID dans la configuration d'authentification. Votre agent peut ensuite appeler en toute sécurité votre webhook.

Toutefois, il existe deux situations dans lesquelles vous devez configurer manuellement cette intégration :

1. Le compte de service Agent de service des agents conversationnels (Dialogflow CX) avec l'adresse suivante doit exister pour votre projet d'agent:

   service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com

   Ce compte de service spécial et la clé associée sont normalement créés automatiquement lorsque vous créez le premier agent pour un projet. Si votre agent a été créé avant le 1er novembre 2020, vous pouvez déclencher la création de ce compte de service spécial :
   1. Créez un agent pour le projet.
   2. Exécutez la commande suivante :

      gcloud beta services identity create --service=dialogflow.googleapis.com --project=agent-project-id

2. Si votre fonction de webhook se trouve dans un projet différent de celui de l'agent, vous devez fournir le rôle IAM Demandeur Cloud Functions à l'agent de service des agents conversationnels (Dialogflow CX) dans le projet de votre fonction.
3. Sélectionnez Authentification de l'agent de service -> Jeton d'identité dans la section "Configuration de l'authentification".

Utiliser des webhooks conteneurisés et le framework Go ezcx

Si vous souhaitez implémenter un webhook conteneurisé à l'aide de Go, consultez le framework ezcx Go. Ce framework peut simplifier de nombreuses étapes requises lors de la création d'un webhook.

Utiliser des fonctions Cloud Run avec du trafic interne uniquement

Les fonctions Cloud Run configurées pour accepter le trafic interne provenant des réseaux VPC du même projet ou du même périmètre VPC SC peuvent être utilisées comme webhook tant que l'agent se trouve dans le même projet ou le même périmètre VPC SC.

Utiliser l'Annuaire des services pour l'accès privé au réseau

Les agents conversationnels (Dialogflow CX) s'intègrent à l'accès au réseau privé de l'Annuaire des services pour pouvoir se connecter aux cibles de webhooks dans votre réseau VPC. Cela permet de conserver le trafic au sein du réseau Google Cloud et d'appliquer IAM et VPC Service Controls.

Pour configurer un webhook ciblant un réseau privé, procédez comme suit :

1. Suivez la page sur la configuration du réseau privé de l'Annuaire des services pour configurer votre réseau VPC et le point de terminaison de l'Annuaire des services.

2. Le compte de service Agent de service des agents conversationnels (Dialogflow CX) avec l'adresse suivante doit exister pour votre projet d'agent:

   service-agent-project-number@gcp-sa-dialogflow.iam.gserviceaccount.com

   Attribuez les rôles IAM suivants au compte de service Agent de service des agents conversationnels (Dialogflow CX):
   • servicedirectory.viewer du projet de l'Annuaire des services
   • servicedirectory.pscAuthorizedService du projet réseau

3. Fournissez le service d'annuaire du service avec l'URL et les informations d'authentification facultatives lors de la création du webhook.

   Console

   

   API

   Consultez le champ serviceDirectory pour le type Webhook. Accéder à la documentation de référence de l'API Webhook

   Sélectionnez un protocole et une version pour la référence du webhook :

   Protocole	V3	V3beta1
   REST	Ressource Webhook	Ressource Webhook
   RPC	Interface du webhook	Interface du webhook
   C++	WebhooksClient	Non disponible
   C#	WebhooksClient	Non disponible
   Go	WebhooksClient	Non disponible
   Java	WebhooksClient	WebhooksClient
   Node.js	WebhooksClient	WebhooksClient
   PHP	Non disponible	Non disponible
   Python	WebhooksClient	WebhooksClient
   Ruby	Non disponible	Non disponible

   Fermer

Pour résoudre les problèmes, vous pouvez configurer un test de disponibilité privé afin de vérifier que votre annuaire des services est correctement configuré.

Exemples et dépannage

Consultez le guide d'utilisation des webhooks.