Guides and Examples

Smart Webhooks (Beta)

This feature is currently in Beta. Any feedback you might have can be sent on email directly to [email protected] and [email protected]. 
Smart webhooks is a way to use generative AI to provide personal answers with data from external sources (CRM, PIM, CMS, OMS, databases, etc).
How it works
You create a normal webhook and add it to your preferred dialogue. The chatbot from Kindly will then know when to call the webhook. 
Pull the data you need from your external source and add it to the response payload in {aiReply.data: {...}}.
Your chatbot will then take the original message from the user, together with the data you provided to generate a personal and tailored reply to the end user. 
How to get started
Create a new webhook, e.g using Firebase. 
Add your webhook endpoint to a dialogue in Kindly under "Advanced options -> Webhook".
When answering your webhook (i.e. the webhook response), make sure your payload looks something likes this:
JS
// Your code to fetch data from your source, like a JSON containing info about a specific product
const dataAboutUserRequest = fetchDataFromSource();

response.json({
  aiReply: {
    data: dataAboutUserRequest // Your response data goes here
  }
}
// Your code to fetch data from your source, like a JSON containing info about a specific product
const dataAboutUserRequest = fetchDataFromSource();

response.json({
  aiReply: {
    data: dataAboutUserRequest // Your response data goes here
  }
}
﻿
Test it by sending a message to the chatbot with the topic you chose earlier. The reply that the chatbot gives back to you will be AI generated and answering your question as long as  the payload you provided contains the necessary data to provide a proper answer. 
General tips
Make sure the data is well structured and keys and values in your payload are well defined and understandble.
The data can be in any form, like just some text, JSON, XLM or anything serialized, but it must be intellegible.
Try to not include irrelevant data, as too much data can result in loss of quality and understanding by the AI.
﻿

Updated 05 Jun 2024

Did this page help you?

Cookies in Chat Widget

Checking webhook signatures (HMACs)