The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Build a UI SDK App for iOS

The UI SDK allows you to add Messaging for In-App into your iOS app with a ready-to-go user experience. Just add the Interface view to your app. You can customize the colors and strings so that the Messaging user interface looks natural in your app. Enhance the experience with push notifications, hidden pre-chat data, user verification, and other features.

This article applies to the following implementations:

UI SDKCore SDK

Import the frameworks from wherever you’re using the SDK.

Create a UIConfiguration instance. To create a configuration instance, you can point to the config file you previously downloaded from your org, or you can manually add the values from within this config file.

This example creates a random UUID for the conversation ID. However, if you want this conversation to persist even after the app is restarted, be sure to use the same conversation ID. Also, if you want to see this same conversation across multiple devices, in addition to using the same conversation ID, turn on user verification, which is described in the Enhance the Experience section.

Once you've added the config.json file to your project, you can reference it from the code.

To learn how to download the config file from your org, see Configure a Messaging for In-App Deployment in Salesforce Help. This file contains the Service API URL, the org ID, and the API name for the deployment. For example:

{
  "OrganizationId": "00ZZZ0000000Zzz",
  "DeveloperName": "MyMessagingForInAppDeployment",
  "Url": "https://zzzz.my.api.url.salesforce-scrt.com"
}

If you don't want to use the config.json file in your project, you can configure the SDK manually using the Service API URL, the org ID, and the API name for the deployment.

If you're using SwiftUI, add the Interface view to your view, using the UIConfiguration instance to initialize and display the chat feed.

If you're using Swift or Objective-C, add the InterfaceViewController view controller to your app, using the UIConfiguration instance to initialize the view controller.

Without any additional code, the UI SDK automatically provides your customers with Messaging features such as pre-chat forms, bot support, file attachments, and estimated wait time. To learn how to configure these features in your org, visit our Messaging for In-App and Web learning map.

In your mobile app, make a call into the SDK with device token information during registration. To learn more, see Set Up Messaging Notifications for iOS.

This step is optional.

The UI SDK automatically brands the app with a default color scheme, provides icons for all UI elements, and uses default text for all UI labels. However, you can customize these elements with the UI SDK.

  • To customize the color scheme in your app, create color sets in your Assets catalog using the SDK's token names. To learn more, see Customize Colors for iOS.
  • To customize any UI text, create a localizable resource file in your app and override the string values. To learn more, see Customize Strings for iOS.
  • To customize the icons and images used throughout the SDK, add an asset to your project's Assets catalog using the associated keyword. To learn more, see Customize Icons for iOS.

This step is optional.

You can enhance your users' experience by adding push notifications, passing information to Salesforce about a verified user, sending hidden pre-chat fields, adjusting chat button visibility based on business hours, and more.

For enhanced features, see Enhance the Experience for iOS.

For an example app, see the UI SDK example in GitHub.