EmbeddedServiceLiveAgent

Represents a setup node for creating a Snap-ins Chat Live Agent deployment. This type extends the Metadata metadata type and inherits its fullName field.

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	string	Required. The font size for the text in the snap-in. The following values are valid: `Small` `Medium` `Large`
headerBackgroundImg	string	Header background image for this snap-in.
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.
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	string	Required. The scenario for the snap-in that determines which objects to relate to the chat. The following string values are valid: `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.

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    <embeddedServiceConfig>04ID000000000FD</embeddedServiceConfig>
4    <enabled>true</enabled>
5    <fontSize>Medium</fontSize>
6    <liveChatButton>573D00000004GgC</liveChatButton>
7    <liveChatDeployment>572D00000004GMd</liveChatDeployment>
8    <masterLabel>EmbeddedServiceLiveAgent_Parent04IRM0000004C9I2AU_15f2777f997</masterLabel>
9    <prechatEnabled>true</prechatEnabled>
10    <scenario>Service</scenario>
11</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.

Metadata API Developer Guide