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

EmbeddedServiceMenuSettings components are stored in the developer_name.EmbeddedServiceMenuSettings folder.

Version

EmbeddedServiceMenuSettings components are available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
branding	string	The developer name of the associated BrandingSet.
embeddedServiceCustomLabels	EmbeddedServiceCustomLabel[]	Represents a customized label that appears in the embedded component for a particular channel menu deployment.
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.
embeddedServiceMenuItems	EmbeddedServiceMenuItem[]	Represents a channel menu item that lists a way in which customers can contact your business.
isEnabled	boolean	If `true` (default), the deployment is enabled. If `false`, the deployment is disabled.
masterLabel	string	Required. The name of the channel menu deployment.
site	string	Required. The name of the Experience site or website connected to this channel menu deployment.

EmbeddedServiceCustomLabel

Represents the custom labels used in your channel menu deployment.

Field Name	Field Type	Description
customLabel	string	The customized label that appears in the channel menu.
feature	EmbeddedServiceFeature (enumeration of type string)	The feature using the custom label. For channel menu deployments, the value is `ChannelMenu`.
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`

EmbeddedServiceMenuItem

Represents an item in a channel menu.

Field Name	Field Type	Description
channel	string	The ID of the channel type. If channelType is `Phone` or `CustomURL`, this field is `null`.
channelType	EmbeddedServiceChannelType (enumeration of type string)	The type of communication channel. Values are: `EmbeddedMessaging` `EmbeddedServiceConfig` `MessagingChannel` `Phone` `CustomURL`
customUrl	string	A custom URL that appears in the menu. The shouldOpenUrlInSameTab field determines where the URL opens.
displayOrder	int	The item’s order in the menu, such as 1 or 2.
embeddedServiceCustomLabels	EmbeddedServiceCustomLabel[]	Represents the custom labels used in your channel menu item.
iconUrl	string	The icon URL for the menu item. Icons can be used only for phone, SMS, custom URL, and chat menu items.
isDisplayedOnPageLoad	boolean	If `true`, the menu item is displayed on page load. Available in API version 49.0 and later.
itemName	string	A unique custom name for the menu item, which is visible in the user interface.
osOptionsHideInIOS	boolean	If `true`, the menu item is hidden in iOS.
osOptionsHideInLinuxOS	boolean	If `true`, the menu item is hidden in Linux operating system.
osOptionsHideInMacOS	boolean	If `true`, the menu item is hidden in Mac operating system.
osOptionsHideInOtherOS	boolean	If `true`, the menu item is hidden in any operating system other than iOS, Linux, Mac, and Windows.
osOptionsHideInWindowsOS	boolean	If `true`, the menu item is hidden in Windows operating system.
phoneNumber	string	The phone number for menu items whose channelType is `Phone`.
shouldOpenUrlInSameTab	boolean	If the menu item’s channelType is `CustomURL`, this field indicates whether the link opens in the same tab (`true`) or a new tab (`false`).

Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceMenuSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<EmbeddedServiceMenuSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <embeddedServiceCustomLabels>
4        <customLabel>CM_Container_Header_Primary_Greeting_3MsRM0000004CB5_6181150</customLabel>
5        <labelKey>CM_Container_Header_Primary_Greeting</labelKey>
6    </embeddedServiceCustomLabels>
7    <embeddedServiceCustomLabels>
8        <customLabel>CM_Container_Header_Secondary_Greeting_3MsRM0000004CB5_4637097</customLabel>
9        <labelKey>CM_Container_Header_Secondary_Greeting</labelKey>
10    </embeddedServiceCustomLabels>
11    <embeddedServiceMenuItems>
12        <channel>Chat</channel>
13        <channelType>EmbeddedServiceConfig</channelType>
14        <displayOrder>1</displayOrder>
15        <embeddedServiceCustomLabels>
16            <customLabel>CM_Container_MenuItems_WebChatUnavailable_3miRM0000004CuZ_8003848</customLabel>
17            <labelKey>CM_Container_MenuItems_WebChatUnavailable</labelKey>
18        </embeddedServiceCustomLabels>
19        <embeddedServiceCustomLabels>
20            <customLabel>CM_Container_MenuItems_WebChatAvailable_3miRM0000004CuZ_5823055</customLabel>
21            <labelKey>CM_Container_MenuItems_WebChatAvailable</labelKey>
22        </embeddedServiceCustomLabels>
23        <itemName>Chat1</itemName>
24        <osOptionsHideInIOS>false</osOptionsHideInIOS>
25        <osOptionsHideInLinuxOS>true</osOptionsHideInLinuxOS>
26        <osOptionsHideInMacOS>false</osOptionsHideInMacOS>
27        <osOptionsHideInOtherOS>false</osOptionsHideInOtherOS>
28        <osOptionsHideInWindowsOS>true</osOptionsHideInWindowsOS>
29        <shouldOpenUrlInSameTab>false</shouldOpenUrlInSameTab>
30    </embeddedServiceMenuItems>
31    <embeddedServiceMenuItems>
32        <channelType>Phone</channelType>
33        <displayOrder>2</displayOrder>
34        <itemName>Phone1</itemName>
35        <osOptionsHideInIOS>true</osOptionsHideInIOS>
36        <osOptionsHideInLinuxOS>false</osOptionsHideInLinuxOS>
37        <osOptionsHideInMacOS>true</osOptionsHideInMacOS>
38        <osOptionsHideInOtherOS>false</osOptionsHideInOtherOS>
39        <osOptionsHideInWindowsOS>false</osOptionsHideInWindowsOS>
40        <phoneNumber>1234567890</phoneNumber>
41        <shouldOpenUrlInSameTab>false</shouldOpenUrlInSameTab>
42    </embeddedServiceMenuItems>
43    <embeddedServiceMenuItems>
44        <channelType>CustomURL</channelType>
45        <customUrl>https://google.com</customUrl>
46        <displayOrder>3</displayOrder>
47        <itemName>url1</itemName>
48        <osOptionsHideInIOS>false</osOptionsHideInIOS>
49        <osOptionsHideInLinuxOS>false</osOptionsHideInLinuxOS>
50        <osOptionsHideInMacOS>false</osOptionsHideInMacOS>
51        <osOptionsHideInOtherOS>false</osOptionsHideInOtherOS>
52        <osOptionsHideInWindowsOS>false</osOptionsHideInWindowsOS>
53        <shouldOpenUrlInSameTab>false</shouldOpenUrlInSameTab>
54    </embeddedServiceMenuItems>
55    <isEnabled>true</isEnabled>
56    <masterLabel>ChannelMenuSettings</masterLabel>
57    <site>SnapInCommunity</site>
58</EmbeddedServiceMenuSettings>

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.