chat_id- The chat ID is a UUID that defines the chat the message belongs to. This ID can be found in the inbox, in the URL of the page.
user_id- The user ID is a string, provided by the chat client that defines the user who triggered the webhook.
exchange- The dialogue (exchange) object that Kindly found and replied with when triggered by the webhook.
exchange_id- The exchange id is a UUID that defines the dialogue that triggered the webhook. It can be found in the URL of the build section, when editing the desired dialogue.
language_code- The language code indicating the dialogue language.
message- The exact phrase that the user wrote to trigger the webhook.
_links- Linked REST resources object (f.ex. chat logs)
chat- If your webhook service requires more information about the chat or the previous messages, this can be fetched from the Chat Log API with a GET request to the url in
_links.chat. Read more about the Chat Log API.
source- Source is the name of the chat client that triggered the webhook. It can be one of the following
web(chat bubble in the browser),
app(Application API) or
test(app.kindly.ai test chat bubble).
web_path- The current URL path for Kindly Chat web clients, which is useful if you are implementing search and want to bias it towards documents related to the current page.
web_host- The current URL host for Kindly Chat web clients.
web_url- The current URL for Kindly Chat web clients.
200 OKJSON response.