Installation

Add the package for your platform, then do the app setup it needs. Every platform also needs a bot key and a market slug from the Kindly platform

Requirements

iOS

Android

Flutter

React Native

iOS 15.4 or later

Swift Package Manager. The SDK is a signed binary, KindlyWebView.xcframework, and there is no CocoaPods pod for native iOS apps

Add the package

iOS

Android

Flutter

React Native

In Xcode, choose File > Add Package Dependencies, enter https://github.com/kindly-ai/sdk-chat-webview and add the KindlyWebView product to your app target. In a Package.swift:

dependencies: [
    .package(url: "https://github.com/kindly-ai/sdk-chat-webview.git", from: "1.0.0"),
],
targets: [
    .target(name: "YourApp", dependencies: [
        .product(name: "KindlyWebView", package: "sdk-chat-webview"),
    ]),
]

A beta needs an exact pin, for example exact: "X.Y.Z-beta.N", because from: never resolves a prerelease

The SDK is on Maven Central as ai.kindly:sdk-webview:

repositories {
    google()
    mavenCentral()
}

dependencies {
    implementation("ai.kindly:sdk-webview:1.0.0")
}

A beta has a version like X.Y.Z-beta.N. Pin an exact version rather than a dynamic one, which Gradle can resolve to a beta

The SDK brings kotlinx-coroutines-core, which is part of its API, and depends on AndroidX WebKit, OkHttp and Sentry's JVM core io.sentry:sentry 8. If your app also uses Sentry 8, Gradle resolves one version for both, the newer of the two

dependencies:
  kindly_webview: ^1.0.0

Then run flutter pub get. A beta, for example X.Y.Z-beta.N, is a prerelease on pub.dev and pub prefers stable versions, so name the beta exactly to try it

yarn add @kindly-ai/[email protected]
cd ios && pod install

With npm, run npm install @kindly-ai/[email protected] instead of yarn add. Autolinking does the rest. A beta, for example X.Y.Z-beta.N, is published under the npm dist-tag beta, so a plain install never picks it: install @kindly-ai/react-native-webview@beta or the exact version to try one

Set up the app

iOS

Android

Flutter

React Native

Add the usage descriptions to your app's Info.plist. No LSApplicationQueriesSchemes entries are needed

Usage descriptions on iOS

The chat lets people attach photos and videos and save images. iOS ends an app that reaches one of these features without its usage description, so add all four keys:

Key	Used for
NSCameraUsageDescription	Taking a photo or video to attach
NSMicrophoneUsageDescription	Recording a video with sound
NSPhotoLibraryUsageDescription	Attaching from the photo library
NSPhotoLibraryAddUsageDescription	Saving an image from the chat

The SDK logs an error at start when the camera, microphone or photo library add description is missing

App-bound domains on iOS

If your app declares WKAppBoundDomains, list chat.kindlycdn.com in it. Without it WebKit blocks the chat's bridge, so the SDK reports itself unsupported and shows an unsupported screen instead of the chat

Android manifest and R8

An Android app adds nothing, whether it uses the SDK directly or through Flutter or React Native. The SDK's manifest merges into your app with:

the INTERNET permission

its chat activity, not exported

a FileProvider with the authority ${applicationId}.kindly.webview.fileprovider, for photos taken in the chat

a <queries> entry for android.media.action.IMAGE_CAPTURE, so the file picker can offer the camera

The consumer R8 rules ship inside the package and keep the SDK's classes, so a minified release build needs no rules of yours. The Android library is already minified

Next, Initialization