Web View SDK

The Kindly web view SDK shows Kindly's chat in your app. It hosts the Kindly web chat widget in a native web view (WKWebView on iOS, Android WebView on Android) and connects it to your app through a bridge that validates every message in both directions. Your app starts the chat, shows and hides it, sends messages, triggers dialogues, passes context, authenticates its users and listens to chat events. The chat's look, texts and behaviour come from your bot's settings in the Kindly platform, so it looks and behaves like the Kindly chat on your website

It is a sibling of the native Kindly SDK, which draws the chat with native views. The two can live in one app, see Next to the Native SDK

Agent-assisted setup

Point your AI coding assistant at the integration guide and it installs the SDK, starts it and shows the chat for you. Prompt to copy:

Use curl to download, read and follow: https://kindly-ai.github.io/sdk-chat-webview-sources/SKILL.md

Packages

Platform	Package	Minimum
iOS	KindlyWebView, Swift Package Manager	iOS 15.4
Android	ai.kindly:sdk-webview, Maven Central	Android 5.0 (API 21), compileSdk 35
Flutter	kindly_webview, pub.dev	Flutter 3.27 and Dart 3.6, iOS 15.4, Android minSdk 24
React Native	@kindly-ai/react-native-webview, npm	React Native 0.82 with the New Architecture, iOS 15.4, Android minSdk 24

The four packages share one version, 1.0.0, and are released together. The Flutter and React Native packages carry the iOS and Android SDKs inside them, so your app adds nothing else. Installation lists every requirement

Quick start

iOS

Android

Flutter

React Native

import KindlyWebView

KindlyWebViewSDK.start(botKey: "YOUR_BOT_KEY", market: "general")
KindlyWebViewSDK.displayChat()

import ai.kindly.webview.KindlyWebViewSDK

class App : Application() {
    override fun onCreate() {
        super.onCreate()
        KindlyWebViewSDK.start(application = this, botKey = "YOUR_BOT_KEY", market = "general")
    }
}

// later, from an Activity
KindlyWebViewSDK.launchChat(this)

import 'package:kindly_webview/kindly_webview.dart';

await KindlyWebViewSDK.start(botKey: 'YOUR_BOT_KEY', market: 'general');
await KindlyWebViewSDK.displayChat();

import { KindlyWebViewSDK } from '@kindly-ai/react-native-webview';

await KindlyWebViewSDK.start({ botKey: 'YOUR_BOT_KEY', market: 'general' });
await KindlyWebViewSDK.displayChat();

Replace YOUR_BOT_KEY with your bot's key and general with a market configured for the bot. The market is required, see Markets

Guides

Getting started: Installation, Initialization, Markets and Configuration

Chat lifecycle: Launch Chat, Close Chat, End Chat and Kill SDK

Features: Events, Authentication, Context, Send a Message, Trigger Dialogue, Uploads and Downloads and Link Interception

Operations: Logging and Crash Reporting, Privacy and Data, Errors, Checking Support, Next to the Native SDK and Limitations

Every code sample comes in four tabs, one per platform. The tab you pick stays picked on every page

API reference

The API reference lists every public type and call of each package, generated from the sources of this version