Embedded Service Chat for Web Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Pass Nonstandard Pre-Chat Details
Follow Pre-Chat Code Examples
Route Chats with Direct-to-Button Routing
Fill In Pre-Chat Fields for Logged-In Users
Set Up and Customize an Automated Invitation
Get Chat Event Notifications
Create a Snippet Settings File for an Experience Site
Add Mobile Accessibility for Chat
Code Snippet Versions
Newer Version Available
Enhance the Pre-Chat Page for Embedded Chat
Pass nonstandard pre-chat details, set up direct-to-button routing, and enable pre-chat fields to fill automatically for logged-in customers.
The legacy chat product is in maintenance-only mode, and we won't continue to build new features. You can continue to use it, but we no longer recommend that you implement new chat channels. Instead, you can modernize your customer communication with Messaging for In-App and Web. Messaging offers many of the chat features that you love plus asynchronous conversations that can be picked back up at any time.
Important
-
Pass Nonstandard Pre-Chat Details
Further control the pre-chat experience using parameters in your Embedded Service code snippet. Two parameters relate to the pre-chat experience: extraPrechatFormDetails and extraPrechatInfo. With these parameters, you can send information to the agent and to your org beyond what’s shown on the pre-chat form. -
Follow Pre-Chat Code Examples
During the pre-chat stage: find existing contacts, avoid attaching records to transcripts, attach a record to an existing field, or override a specific field in your org. These examples and more illustrate some common use cases for pre-chat code snippets. -
Route Chats Based on Pre-Chat Responses with Direct-to-Button Routing
Set your chat window to route chats to different chat buttons based on the customer’s pre-chat response on any and all of your pre-chat fields. Available when you upgrade your code snippet to version 4.0. -
Set Pre-Chat Form Fields to Automatically Populate when Customers Log In
When your customers log in, agents already know basic information like their name and email address. Use this array in your 4.0 code snippet to populate relevant pre-chat fields for them. You can mix and match fields for different record types. This information is for embedded chat windows that are placed outside of Salesforce with Lightning Out (beta). If you use your embedded window in Experience sites, you can enable the contact fields to fill in automatically in the Embedded Chat component settings.