Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

EmbeddedServiceCustomComponent

Represents a custom component created for an Embedded Service feature. The custom components can be an Aura or Lightning Web Component. This object is available in API version 44.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

This type is available only if Salesforce Experiences and Salesforce Sites are enabled in your org. To access this type, you need the Customize Application user permission.

Fields

Field	Details
CustomComponentId	Type reference Properties Create, Filter, Group, Sort, Update Description The unique ID of the LightningComponentBundle or AuraDefinitionBundle component to be used in the Embedded Service.
CustomComponentType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The embedded component type associated with the chosen Feature that you want to customize. The possible values are: `LA_ChatHeader`—Not supported for AuraDefinitionBundle components `LA_Minimized` `LA_PlainTextChatMessage`—Not supported for AuraDefinitionBundle components `LA_Prechat`
EmbeddedServiceConfigId	Type reference Properties Create, Filter, Group, Sort Description The unique ID of the EmbeddedServiceConfig object that this custom component is associated with.
Feature	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The Embedded Service feature that uses the custom component. The possible values are: `Base` `ChannelMenu` `FieldService` `Flows` `LiveAgent` `NotInUse`

Usage

Each Embedded Service feature has a defined set of components that can be customized. You can customize the feature using your own Lightning Web Components or Aura Components. Right now, you can only customize components of the Embedded Service Chat feature. For example, you can customize the prechat form, minimized state, chat bubble, and chat header of a Chat widget.

To customize a component, link the Lightning Web Component or Aura Component to an Embedded Service Custom Component object. Then link an Embedded Service Configuration to this object. The Embedded Service Configuration represents the Chat widget that you want to customize.