EmbeddedServiceConfig

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

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
authMethod	EmbeddedServiceAuthMethod (enumeration of type string)	Type of login method selected for this Snap-ins deployment. One of the following values: `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 for the minimized snap-in in this Snap-ins deployment. Available in API version 43.0 and later.
embeddedServiceCustomLabels	EmbeddedServiceCustomLabel[]	The custom labels used in this Snap-ins deployment. Available in API version 44.0 and later.
masterLabel	string	Required. The name of the embedded service configuration node.
shouldHideAuthDialog	boolean	Specifies whether the prompt that the customer log in again during a flow should be hidden (`true`) or not (`false`). When it’s hidden, the customer is taken directly to your login page. Available in API version 43.0 and later.
site	string	Required. The name of the Salesforce Community or Salesforce Site connected to this Snap-ins deployment.

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 Snap-in.
feature	EmbeddedServiceFeature (enumeration of type string)	The feature that this Snap-in uses. One of the following values: `Base` `FieldService` `LiveAgent` `NotInUse`
labelKey	EmbeddedServiceLabelKey (enumeration of type string)	The type of label for this Snap-in. The value corresponds to the label within a label group (substate of chat state or page type).

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>

Metadata API Developer Guide