Embedded Service Chat for Web Developer Guide
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)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Specify Chat Images
Display the Default Chat Button
Customize the Online, Offline, and Loading Chat Text
Set a Routing Order
Load Files for Custom Chat Events
Modify the Post-Chat
Code Snippet Versions
Change the Embedded Chat Window Appearance and Behavior
Set parameters that affect the appearance and behavior of the chat window
at specific stages. Customize the pre-chat image background, logo, waiting state image, and your
agent avatar and Einstein Bot pictures. Customize the text that appears on the window when chat
is loading, when agents are online, and when agents are offline. Set a routing order and load
your branded files for custom chat events.
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
-
Specify Chat Images
Use your own images for the pre-chat banner, header logo, waiting state image, and the agent and Einstein Bots avatars. We recommend adding your images in Embedded Service setup, but you can use these settings to override what you created in setup. -
Display the Default Chat Button
The default chat button connects your customers to the chat window so they can start a chat from your web page. Valid values are true and false. -
Customize the Online, Offline, and Loading Chat Text
Set the text that’s displayed to your customers in the chat window when there are agents available, when there aren’t agents available, and when the chat is connecting to an agent. We recommend customizing your labels in Embedded Service setup, but you can use these settings to override what you have in Setup. -
Set a Routing Order
Set a list of user IDs and button IDs on your Embedded Service deployment to replace the assigned chat button. When a customer requests a chat, it’s routed to the first available user or button in the list. -
Load Files for Custom Chat Events
Load your own JavaScript and CSS files into Embedded Chat to handle and style custom chat events. Your scripts and styles are loaded only after the agent accepts the chat request. -
Modify the Post-Chat
After you add a post-chat URL for your chat button, you can specify whether it automatically opens or not. Valid values are true and false.