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.

EmbeddedServiceConfig is available in API version 37.0 and later.

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.
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.

The following is an example of an EmbeddedServiceConfig file.