Kindly Android SDK¶
The Kindly Chat SDK for Android allows you to integrate a fully-featured customer support chat into your Android application. The SDK provides a native Jetpack Compose chat interface with real-time messaging, push notifications, custom theming, and more.
Agent-Assisted Setup
Point your AI coding assistant at the skill file below and it will install, initialize, and wire up Kindly for you automatically.
Prompt to copy:
Requirements¶
| Requirement | Minimum Version |
|---|---|
| Android minSdk | API 21 (Android 5.0) |
| compileSdk | 35 |
| Kotlin | 2.0 |
| Jetpack Compose | Enabled (buildFeatures { compose = true }) |
| Java | 1.8+ (source and target compatibility) |
Note
Starting with SDK version 1.0.88, the SDK is compiled with Kotlin 2.x. Projects using Kotlin 1.x must upgrade to Kotlin 2.0 or higher to consume the SDK.
Installation¶
Option A: Maven Central (Recommended)¶
Add the dependency directly — no extra repository needed:
Find the latest version on Maven Central.
Option B: JitPack¶
Add the JitPack repository to your settings.gradle:
// settings.gradle.kts
dependencyResolutionManagement {
repositories {
maven(url = "https://jitpack.io")
}
}
Then add the dependency:
Find the latest version on JitPack.
Quick Start¶
// Initialize in your Application class
KindlySDK.start(
application = this,
botKey = "YOUR_BOT_KEY",
languageCode = "en"
)
// Display the chat from any Activity/Fragment
KindlySDK.launchChat(context = context)
Documentation¶
-
Getting Started
Set up the SDK and configure it for your app
-
Chat Lifecycle
Control how the chat UI is displayed and managed
-
Features
Events, authentication, context, dialogues, and notifications
-
Customization
Theme the chat UI, handle links, and set up deep linking
API Reference¶
Auto-generated documentation for all public classes, interfaces, enums, and data classes.