EmbeddedServiceLiveAgent | Metadata API Developer Guide

File Suffix and Directory Location

EmbeddedServiceLiveAgent components are stored in the developer_name.EmbeddedServiceLiveAgent file in the EmbeddedServiceLiveAgent folder.

Version

EmbeddedServiceLiveAgent is available in API version 38.0 and later.

Fields

Field Name	Field Type	Description
avatarImg	string	Avatar image for this snap-in.
customPrechatComponent	string	The custom Lightning Component that’s used for the pre-chat page in this Snap-ins Chat deployment.
embeddedServiceConfig	string	Required. The name of the embedded service configuration node.
embeddedServiceQuickActions	EmbeddedServiceQuickAction	The quick action used by the pre-chat form.
enabled	boolean	Required. Indicates whether this Snap-ins Chat Live Agent deployment is enabled (`true`).
fontSize	EmbeddedServiceFontSize (enumeration of type string)	Required. The font size for the text in the snap-in. One of the following values: `Small` `Medium` `Large`
headerBackgroundImg	string	Header background image for this snap-in.
isOfflineCaseEnabled	boolean	Indicates whether offline support is enabled for this Snap-ins Chat deployment. Available in API version 43.0 and later.
isQueuePositionEnabled	boolean	Indicates whether queue position (displaying the chat visitor’s place in line while they wait for an agent) is enabled for this Snap-ins Chat deployment. Available in API version 43.0 and later.
liveAgentChatUrl	string	The rest endpoint for Live Agent chats.
liveAgentContentUrl	string	The rest endpoint for Live Agent content.
liveChatButton	string	Required. Reference to a chat button created in Live Agent setup.
liveChatDeployment	string	Required. Reference to a deployment created in Live Agent setup.
masterLabel	string	Required. Name of the Snap-ins Chat Live Agent deployment.
offlineCaseBackgroundImg	string	Offline support case form background image for this snap-in. Available in API version 43.0 and later.
prechatBackgroundImg	string	Pre-chat background image for this snap-in.
prechatEnabled	string	Required. Indicates whether the Snap-ins Chat pre-chat form is enabled for this chat deployment.
prechatJson	string	JSON object of all the fields of the selected pre-chat form in Live Agent setup.
scenario	EmbeddedServiceScenario (enumeration of type string)	Required. The scenario for the snap-in that determines which objects to relate to the chat. One of the following values: `Sales` `Service` `Basic`
smallCompanyLogoImg	string	Company logo image for this snap-in.
waitingStateBackgroundImg	string	Chat waiting image for this snap-in.

EmbeddedServiceQuickAction

Returns a quick action that’s associated with an EmbeddedServiceLiveAgent setup. The quick action include the pre-chat form fields that the snap-in displays and shows the order in which he fields are displayed.

Field Name	Field Type	Description
embeddedServiceLiveAgent	string	Reference to the Snap-ins Chat Live Agent deployment.
order	int	Order in which this quick action appears in the Snap-ins Chat pre-chat form.
quickActionDefinition	string	Reference to a quick action.
quickActionType	EmbeddedServiceQuickActionType (enumeration of type string)	Quick action type. One of the following values: Prechat–Pre-chat OfflineCase–Offline support (Cases) Available in API version 43.0 and later.

Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceLiveAgent file.

1<?xml version="1.0" encoding="UTF-8"?>
2<EmbeddedServiceLiveAgent xmlns="http://soap.sforce.com/2006/04/metadata">
3    <avatarImg>https://google.com/avatar.png</avatarImg>
4    <customPrechatComponent>auraCustomPrechat</customPrechatComponent>
5    <embeddedServiceConfig>EswConfig001</embeddedServiceConfig>
6    <embeddedServiceQuickActions>
7        <embeddedServiceLiveAgent>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</embeddedServiceLiveAgent>
8        <order>1</order>
9        <quickActionDefinition>Snapins_Contact_QuickAction_08hRM000000001h</quickActionDefinition>
10    </embeddedServiceQuickActions>
11    <embeddedServiceQuickActions>
12        <embeddedServiceLiveAgent>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</embeddedServiceLiveAgent>
13        <order>1</order>
14        <quickActionDefinition>Snapins_Case_OfflineCaseQuickAction_08hRM000000001h</quickActionDefinition>
15        <quickActionType>OfflineCase</quickActionType>
16    </embeddedServiceQuickActions>
17    <embeddedServiceQuickActions>
18        <embeddedServiceLiveAgent>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</embeddedServiceLiveAgent>
19        <order>2</order>
20        <quickActionDefinition>Snapins_Case_QuickAction_08hRM000000001h</quickActionDefinition>
21    </embeddedServiceQuickActions>
22    <enabled>true</enabled>
23    <fontSize>Medium</fontSize>
24    <headerBackgroundImg>https://google.com/headerBackgroundImg.png</headerBackgroundIm>
25    <isOfflineCaseEnabled>true</isOfflineCaseEnabled>
26    <isQueuePositionEnabled>true</isQueuePositionEnabled>
27    <liveChatButton>chatButton01</liveChatButton>
28    <liveChatDeployment>liveAgentDeployment01</liveChatDeployment>
29    <masterLabel>EmbeddedServiceLiveAgent_Parent04Ixx0000000001EAA_15ec5bd2971</masterLabel>
30    <offlineCaseBackgroundImg>https://google.com/offlineCaseBackgroundImg.png</offlineCaseBackgroundImg>
31    <prechatBackgroundImg>https://google.com/prechatBackgroundImg.png</prechatBackgroundImg>
32    <prechatEnabled>true</prechatEnabled>
33    <scenario>Service</scenario>
34    <smallCompanyLogoImg>https://google.com/smallCompanyLogoImg.png</smallCompanyLogoImg>
35    <waitingStateBackgroundImg>https://google.com/waitingImage.png</waitingStateBackgroundImg>
36</EmbeddedServiceLiveAgent>

Usage

EmbeddedServiceLiveAgent represents a Live Agent configuration that is added to your web page. The EmbeddedServiceLiveAgent record contains a unique combination of a Live Agent chat button and the Live Agent deployment that the administrator selects during setup.

To create an EmbeddedServiceLiveAgent record:

Create a LiveAgent Deployment record.
Create a LiveAgent Chat Button record.
Create an EmbeddedServiceConfig record.
Set the fields for the LiveAgent Deployment record, LiveAgent Chat Button record, and EmbeddedServiceConfig record as references on the EmbeddedServiceLiveAgent record.

Any changes you make to the image fields override what you’ve entered in Setup. We recommend setting your Snap-ins image URLs in Setup.

Note

Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.