EmbeddedServiceConfig | Metadata API Developer Guide

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.

Important

File Suffix and Directory Location

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

Version

EmbeddedServiceConfig is available in API version 37.0 and later.

Fields

Field Name	Field Type	Description
areGuestUsersAllowed	boolean	Specifies whether a user must be logged in to access an embedded component. Available in API version 45.0 and later.
authMethod	EmbeddedServiceAuthMethod (enumeration of type string)	Type of login method selected for this Embedded Service deployment. Valid values are: `CommunitiesLogin`–Customers log in using Communities. `CustomLogin`–Customers log in using your own custom authentication. Available in API version 43.0 and later.
customMinimizedComponent	string	The custom Lightning component that’s used in this Embedded Service deployment in its minimized state. Available in API version 43.0 and later.
deploymentFeature	EmbeddedServiceDeploymentType(enumeration of type string)	The conversation type of this Embedded Service deployment. Valid values are: LiveAgent Flows FieldService Available in API version 52.0 and later.
deploymentType	EmbeddedServiceDeploymentType (enumeration of type string)	The platform this Embedded Service is deployed to. Valid values are: `Mobile`—For future use `Web` Available in API version 51.0 and later.
embeddedServiceCustomComponents	EmbeddedServiceCustomComponent[]	The custom components used in this Embedded Service deployment. Available in API version 44.0 and later.

embeddedServiceCustomLabels	EmbeddedServiceCustomLabel[]	The custom labels used in this Embedded Service deployment. Available in API version 44.0 and later.
embeddedServiceCustomizations	EmbeddedServiceCustomization[]	The customizations used in this Embedded Service deployment. Each customization is associated with a static resource. Available in API version 50.0 and later.
embeddedServiceFlowConfig	EmbeddedServiceFlowConfig[]	Represents a setup node for creating an embedded flow. Available in API version 45.0 and later.
embeddedServiceFlows	EmbeddedServiceFlow[]	All of the flows used by this Embedded Service deployment. Available in API version 45.0 and later.
isEnabled	boolean	Indicates if this Embedded Service deployment is enabled (true).
masterLabel	string	Required. The name of the Embedded Service configuration node. Available in API version 37.0 and later.
shouldHideAuthDialog	boolean	Specifies whether the prompt that the customer log in again during a flow is hidden (`true`) or not (`false`). When it’s hidden, the customer is taken directly to your login page. This field is set to `false` by default. Available in API version 43.0 and later.
site	string	Required. The name of the Experience site or website connected to this Embedded Service deployment. Available in API version 37.0 and later.

EmbeddedServiceCustomComponent

Returns a custom component that’s associated with an EmbeddedServiceConfig setup.

Field Name	Field Type	Description
customComponent	string	The name of the custom component.
customComponentType	EmbeddedServiceCustomComponent (enumeration of type string)	The type of custom component. Valid values are: `LA_Prechat` (component for pre-chat in Embedded Chat) `LA_Minimized` (component for the minimized chat window) `LA_PlainTextChatMessage` (component for the text area in Embedded Chat)

EmbeddedServiceCustomLabel

Returns a custom label that’s associated with an EmbeddedServiceConfig setup.

Field Name	Field Type	Description
customLabel	string	The customized label that appears in the embedded component.
feature	EmbeddedServiceFeature (enumeration of type string)	The feature that this embedded component uses. Valid values are: `Base` `FieldService` `Flows` `LiveAgent` `NotInUse`
labelKey	EmbeddedServiceLabelKey (enumeration of type string)	The type of label for this embedded component. The value corresponds to the label within a label group (substate of chat state or page type).

EmbeddedServiceCustomization

Returns the customization associated with the Embedded Service feature. Available in API version 50.0 and later.

Field Name	Field Type	Description
customizationName	string	Required. The name of the customization applied to the embedded service. This name can contain only underscores and alphanumeric characters and must be unique in an EmbeddedServiceConfig setup. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
description	string	A description of the customization.
embeddedServiceResources	EmbeddedServiceResource[]	Required. The reference to the static resource that contains the javascript file of the customization.

EmbeddedServiceResource

Returns the static resource associated with the Embedded Service Chat feature customization. Available in API version 50.0 and later.

Field Name	Field Type	Description
resource	string	Required. The ID of the static resource that contains the javascript file of the customization.
resourceType	EmbeddedServiceResourceType (enumeration of type string)	Required. The embedded service feature to customize. Only the Chat feature is supported. Valid values are: `ChatInvitation`

EmbeddedServiceFlow

Returns an embedded flow that’s associated with an EmbeddedServiceConfig setup.

Field Name	Field Type	Description
flow	string	The developer name of the flow.
flowType	EmbeddedServiceFlowType(enumeration of type string)	The type of flow. Valid values are: `FS_Flow` `FS_NewAppointment` `FS_ModifyAppointment` `FS_CancelAppointment` `LA_Survey`
isAuthenticationRequired	boolean	Indicates whether users are required to log in to access the Embedded Service component. The value cannot be `true` for the `FS_Flow` value and must be `true` for all other values.

EmbeddedServiceFlowConfig

Returns the EmbeddedServiceFlowConfig type.

Field Name	Field Type	Description
enabled	boolean	Indicates whether the embedded flow is enabled.

Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceConfig file.

1This is an example of an EmbeddedServiceConfig file.
2<?xml version="1.0" encoding="UTF-8"?>
3<EmbeddedServiceConfig xmlns="http://soap.sforce.com/2006/04/metadata">
4    <authMethod>CommunitiesLogin</authMethod>
5    <customMinimizedComponent>customMinimized</customMinimizedComponent>
6    <masterLabel>EswFS</masterLabel>
7    <shouldHideAuthDialog>false</shouldHideAuthDialog>
8    <site>SiteName</site>
9</EmbeddedServiceConfig>

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.