EmbeddedServiceConfig

Represents a setup node for creating an Embedded Service for Web deployment.

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.

This type extends Metadata and inherits its fields.

EmbeddedServiceConfig components have the suffix .EmbeddedServiceConfig and are stored in the EmbeddedServiceConfig folder.

Introduced in API version 37.0.

  • Type: boolean
  • Required: No
  • Introduced: API version 45.0
  • Description: Specifies whether a user must be logged in to access an embedded component.
  • Type: EmbeddedServiceAuthMethod (enumeration of type string)
  • Required: No
  • Introduced: API version 43.0
  • Description: Type of login method selected for this Embedded Service deployment.
  • Possible values:
    • CommunitiesLogin — Customers log in using Communities.
    • CustomLogin — Customers log in using your own custom authentication.
  • Type: string
  • Required: No
  • Introduced: API version 52.0
  • Description: The branding set that has all of the branding configurations for this Embedded Service configuration.
  • Type: EmbeddedServiceClientVersion (enumeration of type string)
  • Required: No
  • Type: string
  • Required: No
  • Version: Available in API version 43.0 to 45.0.
  • Description: The custom Lightning component that’s used in this Embedded Service deployment in its minimized state.
  • Type: EmbeddedServiceDeploymentFeature (enumeration of type string)
  • Required: Yes
  • Description: The conversation type of this Embedded Service deployment. Available in API version 52.0 and later.
  • Possible values:
    • EmbeddedMessaging — Messaging for In-App and Messaging for Web deployments
    • Flows
    • FieldService
    • LiveAgent
    • None
  • Type: EmbeddedServiceDeploymentType (enumeration of type string)
  • Required: Yes
  • Description: The platform this Embedded Service is deployed to. Available in API version 51.0 and later.
  • Possible values:
    • Mobile — For future use
    • Web
    • API
  • Type: EmbeddedServiceAppointmentSettings
  • Required: No
  • Introduced: API version 46.0
  • Description: The settings of the Embedded Service deployment whose deploymentFeature is FieldService.
  • Type: EmbeddedServiceCustomization[]
  • Required: No
  • Introduced: API version 50.0
  • Description: The customizations used in this Embedded Service deployment. Each customization is associated with a static resource.
  • Type: EmbeddedServiceCustomLabel[]
  • Required: No
  • Introduced: API version 44.0
  • Description: The custom labels used in this Embedded Service deployment.
  • Type: EmbeddedServiceFlowConfig
  • Required: No
  • Introduced: API version 45.0
  • Description: Represents a setup node for creating an embedded flow.
  • Type: EmbeddedServiceFlow[]
  • Required: No
  • Introduced: API version 45.0
  • Description: All of the flows used by this Embedded Service deployment.
  • Type: EmbeddedServiceLayout[]
  • Required: No
  • Introduced: API version 44.0
  • Description: The layout of an Appointment Management deployment of an Embedded Service.
  • Type: boolean
  • Required: No
  • Description: Indicates if this Embedded Service deployment is enabled (true).
  • Type: boolean
  • Required: No
  • Introduced: API version 59.0
  • Description: Indicates whether Terms and Conditions is displayed. Displaying Terms and Conditions is supported if the deploymentFeature is either EmbeddedMesssaging or LiveAgent. The default is false.
  • Type: boolean
  • Required: No
  • Introduced: API version 59.0
  • Description: Indicates whether acceptance of the Terms and Conditions is required before starting a chat. Displaying Terms and Conditions is supported if the deploymentFeature is either EmbeddedMesssaging or LiveAgent. The default is false.
  • Type: string
  • Required: Yes
  • Introduced: API version 37.0
  • Description: Required. The name of the Embedded Service configuration node.
  • Type: boolean
  • Required: No
  • Introduced: API version 43.0
  • Description: 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.
  • Type: string
  • Required: No
  • Introduced: API version 37.0
  • Description: Required. The name of the Experience site or website connected to this Embedded Service deployment.
  • Type: EswInvitationConditionResource (enumeration of type string)
  • Required: Yes
  • Type: string
  • Required: No
  • Type: EswInvitationConditionOperator (enumeration of type string)
  • Required: Yes
  • Type: int
  • Required: Yes
  • Type: string
  • Required: Yes

Returns the settings of an Embedded Service deployment whose deploymentFeature is FieldService.

Introduced in API version 46.0.

  • Type: string
  • Required: No
  • Description: The URL of the image to display when an appointment is confirmed.

  • Type: boolean

  • Required: Yes

  • Description: Required.

    Indicates whether this deployment is enabled. The default is false.

  • Type: string
  • Required: No
  • Description: The URL of the image to display on the appointment management widget home screen.
  • Type: string
  • Required: No
  • Description: The URL of the logo to display in the appointment management widget.
  • Type: boolean
  • Required: No
  • Description: Indicates whether existing appointments are displayed in the appointment management widget. The default is false.
  • Type: boolean
  • Required: No
  • Description: Indicates whether new appointments are displayed in the appointment management widget. The default is false.

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

  • Type: EmbeddedServiceComponentBundleType (enumeration of type string)
  • Required: No
  • Type: string
  • Required: No
  • Description: The name of the custom component.
  • Type: EmbeddedServiceCustomComponentType (enumeration of type string)
  • Required: No
  • Description: The type of custom component.
  • Possible values:
    • 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)
    • MIAW_Prechat — (component for the prechat form in Messaging for In-App and Web)
    • MIAW_Header — (component for the header of the messaging conversation window in Messaging for In-App and Web)
    • MIAW_TextMessage — (component for the text message bubbles in a Messaging for In-App and Web conversation)

Returns the customization associated with the Embedded Service feature.

Introduced in API version 50.0.

  • Type: string
  • Required: Yes
  • Description: 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.
  • Type: string
  • Required: No
  • Description: A description of the customization.
  • Type: EmbeddedServiceResource[]
  • Required: No
  • Description: Required. The reference to the static resource that contains the javascript file of the customization.

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

  • Type: string
  • Required: No
  • Description: The customized label that appears in the embedded component.
  • Type: EmbeddedServiceFeature (enumeration of type string)
  • Required: No
  • Description: The feature that this embedded component uses.
  • Possible values:
    • Base
    • ChannelMenu
    • EmbeddedMessaging — Messaging for In-App and Messaging for Web deployments
    • FieldService
    • Flows
    • LiveAgent
    • NotInUse
  • Type: EmbeddedServiceLabelKey (enumeration of type string)
  • Required: No
  • Description: 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).

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

  • Type: string
  • Required: Yes
  • Description: The developer name of the flow.
  • Type: EmbeddedServiceFlowType (enumeration of type string)
  • Required: Yes
  • Description: The type of flow.
  • Possible values:
    • FS_CancelAppointment
    • FS_Flow
    • FS_ModifyAppointment
    • FS_NewAppointment
    • LA_Survey
  • Type: boolean
  • Required: Yes
  • Description: Indicates whether users are required to log in to access the Embedded Service component. The value can’t be true for the FS_Flow value and must be true for all other values.

Returns the form that’s used for pre-chat.

Introduced in API version 62.0.

  • Type: EmbeddedServiceFormDisplayContext (enumeration of type string)
  • Required: No
  • Description: Required. Indicates when we display this form. Values are:
  • Possible values:
    • Session — The pre-chat form is displayed every session.
    • Conversation — Tthe pre-chat form is displayed every conversation.
    • None — Don’t select this option.
  • Type: EmbeddedServiceFormType (enumeration of type string)
  • Required: No
  • Type: boolean
  • Required: No
  • Description: Indicates whether the form is active. The default value is false.

Represents an individual field in a prechat form. Available in API version 62.0 or higher.

  • Type: string
  • Required: No
  • Description: The choice list that’s associated with EmbeddedServiceFormField. ChoiceList can only be associated if the formField is set to CustomMessagingChannelParameter and messagingChannelParameterType is set to Custom.
  • Type: int
  • Required: Yes
  • Description: Indicates the relative order of the form field in the prechat form. For Prechat fields where isHidden is set to true displayOrder must be set to -1. For Prechat fields where isHidden is set to false, this value must be greater than or equal to 0.
  • Type: string
  • Required: Yes
  • Description: Required. Maps to either a StandardMessingChannelParameter or a CustomMessagingChannelParameter

  • Type: EmbeddedServiceFormFieldType (enumeration of type string)

  • Required: Yes

  • Description: Required. Indicates the type of data is passed by the End User when filling out the Prechat form. Valid values are:

    • Text
    • Email
    • Phone
    • Number
    • Checkbox
    • Choicelist
  • Type: boolean
  • Required: No
  • Description: Indicates whether a Prechat form field is displayed in the UI. isHidden can only be set to true if the formField field is set to CustomMessagingChannelParameter and messagingChannelParameterType is set to Custom.
  • Type: boolean
  • Required: No
  • Description: Indicates whether a Prechat form field is required. If isHidden is set to true, isRequired must be set to false.
  • Type: MessagingChannelParameterType (enumeration of type string)
  • Required: Yes
  • Description: Required. Indicates whether formField points to a StandardMessagingChannelParameter or a CustomMessagingChannelParameter. Please match the Enum value here to the formField passed in. Valid values for MessagingChannelParameterType are: Valid values for StandardMessagingChannelParameter are:
  • Possible values:
    • Standard — select this field when you want to reference a StandardMessagingChannelParameter
    • Custom — select this field when you want to reference a CustomMessagingChannelParameter
    • FirstName
    • LastName
    • Email
    • Subject

Returns the layout of an Embedded Service deployment whose deploymentFeature is FieldService.

Introduced in API version 44.0.

  • Type: EmbeddedServiceLayoutRule[]
  • Required: No
  • Description: The appointment statuses that the layout of the Embedded Service deployment is valid for.
  • Type: string
  • Required: Yes
  • Description: The FlexiPage that represents the layout of this Embedded Service deployment.

  • Type: EmbeddedServiceLayoutType (enumeration of type string)

  • Required: No

  • Description: The type of layout applied to the Embedded Service deployment.

    Values are:

  • Possible values:

    • FS_AppointmentHome

Returns an appointment status for which the Embedded Service layout is valid for. This subtype is for Embedded Service deployments whose deploymentFeature is FieldService.

Introduced in API version 44.0.

  • Type: string
  • Required: Yes
  • Description: The service appointment status that the EmbeddedServiceLayout subtype is valid for.

Returns the settings of an Embedded Service deployment whose deploymentFeature is EmbeddedMessaging. Available in API version 62.0 or higher.

  • Type: string
  • Required: No
  • Description: The Business Hours record that’s associated with this specific embedded service deployment.
  • Type: string
  • Required: No
  • Type: EmbeddedServiceChatFabDisplay (enumeration of type string)
  • Required: No
  • Type: EmbeddedServiceChatFabDisplay (enumeration of type string)
  • Required: No
  • Type: string
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: Yes
  • Description: Required. Indicates whether this embedded service deployment is enabled.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: string
  • Required: Yes
  • Description: Required. The MessagingChannel record that’s associated with this specific embedded service deployment.
  • Type: boolean
  • Required: Yes
  • Type: boolean
  • Required: Yes
  • Description: Required. Indicates whether delivery receipts are shown in the UI.
  • Type: boolean
  • Required: Yes
  • Description: Required. Indicates whether emoji selection is shown in the UI.
  • Type: boolean
  • Required: Yes
  • Description: Required. Indicates whether read reciepts are shown in the UI.
  • Type: boolean
  • Required: Yes
  • Description: Required. Indicates whether typing indicators are shown in the UI.
  • Type: boolean
  • Required: Yes
  • Description: Required. Indicates whether pressing Enter starts a new line of text in the UI.

Returns the static resource associated with the Embedded Service Chat feature customization.

Introduced in API version 50.0.

  • Type: string
  • Required: Yes
  • Description: Required. The ID of the static resource that contains the javascript file of the customization.
  • Type: EmbeddedServiceResourceType (enumeration of type string)
  • Required: Yes
  • Description: Required. The embedded service feature to customize.
  • Possible values:
    • ChatInvitation — Use for Chat deployments.
    • SettingsFile — Use if you’re configuring a settings file for a Channel Menu deployment.

The following is an example of an EmbeddedServiceConfig 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.