Embedded Service Chat SDK for iOS Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Embedded Service Chat SDK for iOS Developer Guide
Release Notes
Service Cloud Setup
SDK Setup
Requirements
Accessibility
Data Collection
Installation
Add the Service SDK Frameworks with CocoaPods
Add the Service SDK Frameworks Manually
Authentication
Notifications
Prepare Your App for Submission
iOS Tutorials & Examples
Chat
SDK Customizations
Troubleshooting
Data Protection and Security
Reference Documentation
Additional Resources
PDF

Add the Service SDK Frameworks with CocoaPods

Add the SDK frameworks using CocoaPods, a developer tool that automatically manages dependencies.

The legacy chat product is scheduled for retirement on February 14, 2026, and is in maintenance mode until then. During this phase, you can continue to use chat, but we no longer recommend that you implement new chat channels. To avoid service interruptions to your customers, migrate to Messaging for In-App and Web before that date. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time. Learn about chat retirement in Help.

Important

  1. If you haven't already done so, install the CocoaPods gem and initialize the CocoaPods main repository. 
    sudo gem install cocoapods
pod setup

    The minimum supported version of CocoaPods is 1.0.1. If you're not sure what version you have, use pod --version to check the version number.

    Note

  2. If you already have CocoaPods installed, update your pods to the latest version. 
    pod update
  3. Change to the root directory of your application project.
  4. Create or edit a file named Podfile that contains the Service Chat SDK dependency.
    1. If you want to install the complete Service Chat SDK, update your Podfile to include ServiceSDK. 
      source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/goinstant/pods-specs-public'

# To use the SDK (with all components)
target '<your app target>' do
    pod 'ServiceSDK'
end
    2. If you want to install a single Service Chat SDK component, create a similar Podfile to the one specified above, but only include the desired pod.
      Feature Pod name
      Chat ServiceSDK/Chat

      For example, the following Podfile installs Chat.

      source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/goinstant/pods-specs-public'

# To use Chat
target '<your app target>' do
    pod 'ServiceSDK/Chat'
end

      If you don't specify a version number, you automatically get the latest version of that component. If you want to add a specific version to your component, be sure to add the version number of the Service Chat SDK and not the version number of the individual component.

  5. Run the CocoaPods installer. 
    pod install

    This command generates a .xcworkspace file for you with all the dependencies included.

    If you run into issues installing or updating the SDK, clear the local CocoaPods cache and then perform a pod update.

    Note

  6. Open the .xcworkspace file that CocoaPods generated and continue with the installation process.

    Be sure to open the .xcworkspace file (which includes all the dependencies) and not the .xcodeproj file.

    Note

Once you've added the SDK frameworks, proceed with the installation instructions.