Metadata API Developer Guide
jNewer Version Available
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 | EmbeddedServiceFontSize (enumeration of type string) | Required. The font size for the text in the snap-in. One of the following
values:
|
| 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:
|
| 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:
|
Declarative Metadata Sample Definition
The following is an example of an EmbeddedServiceLiveAgent file.
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.