Embedded Service for Web Developer Guide

Embedded Service for Web Developer Guide
Customize Your Embedded Component
Customize Embedded Chat
Customize Chat Parameters
Set Up and Customize an Automated Invitation
Get Chat Event Notifications
Add Mobile Accessibility for Chat
Create Custom Chat Events
Bootstrap Embedded Chat
Start, End, and Clear Embedded Chat Sessions
Create a Snippet Settings File
Enhance Pre-Chat
Customize the Channel Menu
Embedded Service Customized Components
Code Snippet Versions
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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.

embedded_svc.bootstrapEmbeddedService(attributes);

Note: This API does not start a chat request to an agent. See Start, End, and Clear Embedded Chat Sessions for an API related to this topic.

Note

Use the attributes JSON object parameter to pass information to the Embedded Chat Bootstrap API to launch the sidebar for a chat visitor. This function loads necessary scripts and dependencies and creates the Embedded Chat application.

Your attributes parameter should include the attributes from the table.

Name Type Description
baseCoreURL string The URL path for an organization’s instance.
communityEndpointURL string The string representing a community endpoint.

The attributes parameter is optional. If you don’t provide attributes, this function uses what is stored in embedded_svc.settings from the code snippet on your page.

Note