Introduction
Welcome to the Kindly 🟢 developer documentation!
This is your central resource for integrating and interacting with the Kindly system, whether you're looking to add a powerful chat widget to your site or leverage our conversational AI and management tools directly within your own applications.
Kindly is a software system for building and managing AI-powered chatbots. These documents provide the tools and guides you need to customize and extend your bot's capabilities.
How to use these docs
We've organized the documentation around what you want to achieve. There are three main ways to build with Kindly:
- Kindly Chat Widget 💬
- This is the fastest way to add a complete, customizable chat experience to your website or mobile app.
- ➡️ Go to the section for setup instructions, customization options, proactivity features and our iOS & Android SDKs.
- Headless API Interaction 🕹️
- Use our suite of APIs to programmatically interact with the Kindly system. This is the right path if you want to build a custom "headless" chat client, or if you need to manage and analyze conversations. This includes:
- Sending and receiving messages with the Application API.
- Managing conversations by fetching transcripts or signaling a agent handover with the Chat transcript API and Handover API.
- Retrieving data like chat statistics for your own dashboards with the Statistics API.
- Webhooks 🪝
- Make your bot trigger actions in your external systems. You add a webhook endpoint in the Kindly Platform to a specific dialogue, and we will send a request to your service when that dialogue is triggered. This is perfect for pushing data to your CRM, customizing the answer according to some external information, or connecting to any custom third-party service.
We also have ready-to-use integrations for 📞 Voice bots and 📧 Email bots, get in touch with us to set them up with your system!
Understanding Kindly concepts
Before you dive in, we recommend visiting our "Concepts" section. There, you will find general info and explanations of common concepts of the Kindly system, including:
- Languages: How and which languages are supported by Kindly.
- Conversation context: How the bot "persists" information throughout a conversation.
These are helpful themes to know when approaching for the first time our documentation. Have a look here.
Getting Access to the Kindly Platform
The Kindly Platform, accessible at app.kindly.ai, is where you build, manage, and configure your bots. To use the Platform, the Widget or our APIs, you first need a user account there.
If you don't have an account yet, please email [email protected] to request an invite from our team. If you already have an account with the necessary permissions, you can invite new members to your organization directly from the Platform.
The ability to invite members or configure certain aspects of a bot depends on your assigned organization privileges.
Feedback
We are constantly working to improve our documentation. If you find anything that is unclear, inaccurate, or missing, please let us know. You can reach us at [email protected]. Thank you!