Webhooks

La bibliothèque WebhookClient dans le kit SDK Node.js d'Oracle Digital Assistant simplifie la configuration de l'envoi et de la réception de messages dans les canaux de webhook. Si vous n'utilisez pas le kit SDK, voici ce que vous devez savoir sur la création de messages entrants.

L'appel permettant d'envoyer des messages à votre assistant numérique (ou brique) doit comporter les éléments suivants :

1. En-tête X-Hub-Signature contenant la valeur SHA256 de la charge utile. Cet appel inclut des fonctions qui créent le hachage en utilisant la clé secrète en tant que clé.

   const body = Buffer.from(JSON.stringify(messageToBot), 'utf8');
       const headers = {};
       headers['Content-Type'] = 'application/json; charset=utf-8';
       headers['X-Hub-Signature'] = buildSignatureHeader(body, channelSecretKey);
   
   ...
   
   function buildSignatureHeader(buf, channelSecretKey) {
       return 'sha256=' + buildSignature(buf, channelSecretKey);
   }
   
   function buildSignature(buf, channelSecretKey) {
       const hmac = crypto.createHmac('sha256', Buffer.from(channelSecretKey, 'utf8'));
       hmac.update(buf);
       return hmac.digest('hex');
   }

   BOT_WEBHOOK_URL et BOT_WEBHOOK_SECRET sont des variables d'environnement que vous définissez sur le serveur de noeud. L'utilisation de ces variables d'environnement vous permet d'éviter de coder en dur les informations sensibles directement dans le webhook.

2. Objet JSON comportant les propriétés userId, profile et messagePayload :

   {
    "userId": "33c0bcBc8e-378c-4496-bc2a-b2b9647de2317",
    "profile": {
       "firstName": "Bob",
       "lastName": "Franklin",
       "age": 45
      },
    "messagePayload": {....}
   }

   Propriété	Description	Type	Requis ?
   userId	Identificateur unique de l'utilisateur. Cet ID est propre à l'appelant.	Chaîne	Oui
   profile	Propriétés représentant l'utilisateur, telles que firstName et LastName.	Objet JSON	Non
   messagePayload	La valeur messagePayload peut être text, postback, attachment ou location.	Objet JSON	Oui

   Remarque
   
   Si votre brique ou votre assistant numérique doit détecter la langue utilisateur, assurez-vous que profile.locale et profile.languageTag sont définis sur NULL dans les messages de webhook.

La bibliothèque WebhookClient dans le kit SDK Node.js d'Oracle Digital Assistant simplifie la configuration de l'envoi et de la réception de messages dans les canaux de webhook. Si vous n'utilisez pas le kit SDK, voici ce que vous devez savoir sur la création de messages sortants.

Vous devez publier les appels au format JSON attendu par Digital Assistant, ainsi que l'en-tête d'autorisation.