--- schema_version: "1" id: 195c633dc86eaab09bfe9889cf64d63608836b039b489dfc7a1e1cbe18c407d3 title: EmbeddedServiceLiveAgent collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_embeddedserviceliveagent.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_embeddedserviceliveagent.htm source_site: developer.salesforce.com content_type: documentation content_hash: 3481f2bff82a1ee04b35d56df1b5e44a64cde59b660b5d3873874ae40ee62970 description: Represents a setup node for creating an embedded chat deployment. This type extends the Metadata metadata type and inherits its fullName field. --- # EmbeddedServiceLiveAgent Represents a setup node for creating an embedded chat deployment. This type extends the Metadata metadata type and inherits its fullName field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## 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 embedded chat deployment.
customPrechatComponent string The custom Lightning Component that’s used for the pre-chat page in this embedded 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 embedded chat deployment is enabled (true).
fontSize EmbeddedServiceFontSize (enumeration of type string) Required. The font size for the text in the embedded chat window. One of the following values:
  • Small
  • Medium
  • Large
headerBackgroundImg string Header background image for this embedded chat window. Removed in API version 49.0.
isOfflineCaseEnabled boolean Indicates whether offline support is enabled for this embedded 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 embedded chat deployment. Available in API version 43.0 and later.
liveAgentChatUrl string The rest endpoint for chats.
liveAgentContentUrl string The rest endpoint for cChat content.
liveChatButton string Required. Reference to a chat button created in Chat setup.
liveChatDeployment string Required. Reference to a deployment created in Chat setup.
masterLabel string Required. Name of the embedded chat deployment.
offlineCaseBackgroundImg string Offline support case form background image for this embedded chat window. Available in API version 43.0 and later.
prechatBackgroundImg string Pre-chat background image for this embedded chat window.
prechatEnabled string Required. Indicates whether the embedded chat pre-chat form is enabled for this deployment.
prechatJson string JSON object of all the fields of the selected pre-chat form in Chat setup.
scenario EmbeddedServiceScenario (enumeration of type string) Required. The scenario for the embedded chat window that determines which objects to relate to the chat. One of the following values:
  • Sales
  • Service
  • Basic
smallCompanyLogoImg string Company logo image for this embedded chat window.
waitingStateBackgroundImg string Chat waiting image for this embedded chat window.
## EmbeddedServiceQuickAction Returns a quick action that’s associated with an EmbeddedServiceLiveAgent setup. The quick action includes the pre-chat form fields that the embedded chat window displays and shows the order in which the fields are displayed.
Field Name Field Type Description
embeddedServiceLiveAgent string Reference to the embedded chat deployment.
order int Order in which this quick action appears in the embedded 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. https://google.com/avatar.png auraCustomPrechat EswConfig001 EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971 1 Snapins\_Contact\_QuickAction\_08hRM000000001h EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971 1 Snapins\_Case\_OfflineCaseQuickAction\_08hRM000000001h OfflineCase EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971 2 Snapins\_Case\_QuickAction\_08hRM000000001h true Medium https://google.com/headerBackgroundImg.png true true chatButton01 liveAgentDeployment01 EmbeddedServiceLiveAgent\_Parent04Ixx0000000001EAA\_15ec5bd2971 https://google.com/offlineCaseBackgroundImg.png https://google.com/prechatBackgroundImg.png true Service https://google.com/smallCompanyLogoImg.png https://google.com/waitingImage.png ## Usage EmbeddedServiceLiveAgent represents a Chat configuration that is added to your web page. The EmbeddedServiceLiveAgent record contains a unique combination of a chat button and the Chat deployment that the administrator selects during setup. To create an EmbeddedServiceLiveAgent record: 1. Create a Chat Deployment record. 2. Create a Chat Button record. 3. Create an EmbeddedServiceConfig record. 4. Set the fields for the Chat Deployment record, 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 image URLs in Setup. ## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).