This is the place for important historical and upcoming changes, fixes, and features across our APIs.

Changes to our APIs that have been released and deployed.

Discover the latest additions and updates to various APIs in this comprehensive document. Explore the exciting new features introduced by the Chat API, such as 'kindly:ui' events and 'sendMessage()' method. Uncover breaking changes like the discontinuatio

Statistics API (deprecated)

APIs Changelog

server_side_handover

client_side_handover

Security

Kindly Docs

Getting started with webhooks

Webhooks reference

Message processing

Pattern dialogues

Context memory

Languages

Cookies in Chat Widget

Introduction

Smart Webhooks (Beta)

Checking webhook signatures (HMACs)

Example: Chat transcript webhook

Kindly Chat authentication

Inbox backup to S3 bucket

Inbox backup to GCS bucket

Add the Spinnaker script tag to your site

Set up event tracking with Google Tag Manager (GTM)

Application API

Chat Widget API

Chat Transcript API

Handover API

Nudge API

Statistics API

iOS SDK

Android SDK

Text Predict API

License and Disclaimer

Date	Type	Change
2024-04-10	✨ New feature	Add cancelHandover() method.
2023-10-25	✨ New feature	Add dismiss-feedback ui event.
2023-10-12	✨ New feature	Add kindly:ui events.
2023-10-10	✨ New feature	Implement restartChat() method.
2023-08-08	✨ New feature	Implement sendMessage() method.
2022-06-15	💥 Breaking change	Stop supporting Internet Explorer.
2022-02-01	💥 Breaking change	Remove support for Kindly Chat versions v2.0.0 and older. Version 2 was released 2020-11-03.

Date	Type	Change
2023-07-25	✨ New feature	Add organization_id to the response payload.
2023-06-14	✨ New feature	Add labels to the response payload.
2022-09-01	💥 Breaking change	Remove legacy chat log API endpoint at api.kindly.ai/api/v1/bot/:botId/conversations/chat/:chatId/.
2022-01-11	⚰️ Deprecation	The legacy chat log API endpoint at api.kindly.ai/api/v1/bot/:botId/conversations/chat/:chatId/ is now deprecated since we have a functionally equivalent and more robust API available. To avoid disruption, please migrate to the new endpoint at https://bot.kindly.ai/api/v1/chats/:chatId before 2022-09-01. There are very few changes required. Learn how on .

Date	Type	Change
2023-07-25	✨ New feature	Add organization_id and bot_id to the posted payload.
2023-06-14	✨ New feature	Add chat_labels to the posted payload.

Date	Change
2023-07-25	Rename "Chat log API" to "Chat Transcript API"
2022-04-20	Moved 2022-02-01 breaking change in Kindly Chat to history.
2022-01-11	Added initial overview

APIs Changelog

🔮 Upcoming API changes

📖 History of API changes

Application API

Chat API

Chat Transcript API

Handover API

Statistics API

Webhooks

This page