You are here:
Configure a Custom Client Deployment for Enhanced Chat
To enjoy granular control of your web or mobile app messaging experience, create a custom client deployment for Enhanced Chat. While our web or mobile deployments rely on our web client and mobile SDK, a custom client deployment lets you deliver a highly customized UI with the Enhanced Chat REST API.
Required Editions
| View supported editions. | |
This article applies to:
|
Enhanced In-App Chat and Enhanced Web Chat channels |
This article doesn’t apply to:
|
Enhanced WhatsApp, Standard and Enhanced Facebook Messenger, Standard and Enhanced SMS, Enhanced Apple Messages for Business, Enhanced LINE, and Bring Your Own Channel |
| User Permissions | |
|---|---|
| To set up this feature: | Customize Application AND Modify Metadata Through Metadata API Functions |
| To modify permission sets and profiles: | Manage Profiles and Permission Sets |
The Enhanced Chat REST API can be used to create conversations that house messaging sessions, generate access tokens, and send messages and files. You can also integrate an external bot solution or partner-supported messaging solutions.
In this stage of Enhanced Chat setup, publish a deployment, customize your deployment, and reference the deployment when invoking public REST API endpoints.
Publish a Deployment
Create a custom client deployment that can be referenced in public REST API endpoints.
-
Complete the steps in Prepare a Salesforce Org for Enhanced Chat:
- Configure Omni-Channel.
- Create an Omni-Channel flow to route messages.
- Create an Enhanced Chat channel on the Messaging Settings page. This will create an Enhanced Chat deployment automatically, but it’s not a custom client deployment. Ignore the deployment that gets created in this process.
- Configure the Service Console to support messaging.
- From Setup, in the Quick Find box, enter Embedded Service Deployments, and select Embedded Service Deployments.
- Click New Deployment.
- Select Enhanced Chat, and then click Next.
- Click Custom Client, and then click Next.
- Name your Embedded Service deployment, and customize the API name if desired.
- Select the Enhanced Chat channel that you created earlier. If you haven’t created one yet, go to the Messaging Settings page and do so.
- Save your work.
- Create and publish your new deployment, which takes a few minutes. Don’t navigate away from the page until it’s complete.
Customize Your Deployment
On the Embedded Service Deployment Settings page shown after your deployment is saved, you can customize your deployment.
- Click the Push Notifications tile to configure push notifications if it will be used with a mobile app. See Set Push Notifications for Enhanced In-App Chat.
- Click the Pre-Chat tile to prepare a pre-chat form that customers must complete before messaging with a service rep. See Customize Pre-Chat for Enhanced Chat.
After you edit a deployment, publish it again by clicking Publish on the settings page.
Reference Your Deployment with the Enhanced Chat REST API
Supply your deployment name when invoking a public endpoint from the Enhanced Chat REST API.
