Kindly iOS SDK

The Kindly Chat SDK for iOS allows you to integrate a fully-featured customer support chat into your iOS application. The SDK provides a native UIKit-based chat interface with real-time messaging, push notifications, custom theming, and more.

Installation

Swift Package Manager

Add the Kindly SDK to your project via Xcode:

1. Go to File > Add Package Dependencies
2. Enter the repository URL: https://github.com/kindly-ai/sdk-chat-ios
3. Select the version you want to use

Or add it to your Package.swift:

dependencies: [
    .package(url: "https://github.com/kindly-ai/sdk-chat-ios", from: "2.0.0")
]

CocoaPods

Add the following to your Podfile:

pod 'Kindly'

Then run pod install.

Quick Start

import Kindly

// Initialize the SDK
KindlySDK.start(botKey: "YOUR_BOT_KEY")

// Display the chat
KindlySDK.displayChat()

Documentation

• Getting Started

  ---

  Set up the SDK and configure it for your app

  Initialization Configuration

• Chat Lifecycle

  ---

  Control how the chat UI is displayed and managed

  Launch Chat Close Chat End Chat Kill SDK

• Features

  ---

  Events, authentication, context, dialogues, and notifications

  Events Authentication Notifications

• Customization

  ---

  Theme the chat UI, handle links, and set up deep linking

  Custom Theming URL Schemes Link Interception

API Reference

Auto-generated documentation for all public classes, protocols, enums, and structs.

Browse API Reference