Embedded Service for Web Developer Guide
Summer '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)
Set Up and Customize an Automated Invitation
Get Chat Event Notifications
Add Mobile Accessibility for Chat
Bootstrap Embedded Chat
Start, End, and Clear Embedded Chat Sessions
Create a Snippet Settings File
Code Snippet Versions
Newer Version Available
Customize Embedded Chat
Take full control of the chat experience from pre-chat to post-chat. Use customizable
parameters in the Embedded Servicecode snippet. Expand pre-chat functionality by passing
nonstandard pre-chat details, setting up direct-to-button routing, and enabling pre-chat
fields to fill automatically for logged-in customers. Connect an automated invitation to
your chat window and implement your own HTML and CSS.
-
Set Up and Customize an Automated Invitation
Connect an automated chat invitation with your Embedded Service deployment to proactively invite your customers to start a chat with an agent. Your invitation can slide, fade, or appear anywhere on the page based on the criteria you selected in Setup. You can also use your own HTML and CSS to make it match your company’s branding. Upgrade your code snippet to version 4.0 to use invitations. -
Get Chat Event Notifications
Set up notifications when certain chat events are triggered. Subscribe to these particular events by calling to embedded_svc.addEventHandler in your Embedded Chat code snippet. -
Add Mobile Accessibility for Chat
Provide an accessible Embedded Chat experience on your website for mobile customers. -
Create Custom Chat Events
Custom chat events let you have your own communication channel with your customers using the agent console to send and receive your own chat events. Create custom events using your own JavaScript and CSS files. -
Bootstrap Embedded Chat
The Bootstrap API allows you to load all the necessary dependencies, bootstrap, and open the chat sidebar on your website with a single function call. Use the Embedded Service code snippet version 5.0 and later. The APIs are not available in Communities with Lightning Locker enabled. -
Start, End, and Clear Embedded Chat Sessions
Three APIs allow you to start, end, and clear sessions for Embedded Chat. Use the Embedded Service code snippet version 5.0 and later. The APIs are not available in Communities with Lightning Locker enabled. -
Create a Snippet Settings File to Use Snippet Settings in a Community
Take your snippet-only settings like extra pre-chat configuration and direct-to-button routing to your Communities chat window. Create a JavaScript file and upload it as a static resource that you reference in your Embedded Chat Community component settings. -
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.