EmbeddedServiceCustomComponent

Represents a custom component created for an Embedded Service feature.

Version 

Introduced in API version 44.0.

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 

CustomComponentId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Introduced: API version 44.0

• Description: The unique ID of the LightningComponentBundle or AuraDefinitionBundle component to be used in the Embedded Service.

• Relationship name: CustomComponent

• Relationship type: polymorphic

• Refers to: AuraDefinitionBundle, LightningComponentBundle

CustomComponentType 

• Type: picklist

• Required: No

• Properties: Create, Filter, Group, Restricted picklist, Sort, Update

• Introduced: API version 44.0

• Description: The embedded component type associated with the chosen Feature that you want to customize.

• Possible values:

  • LA_Prechat — LA_Prechat

  • LA_Minimized — LA_Minimized

  • LA_PlainTextChatMessage — LA_PlainTextChatMessage — Not supported for AuraDefinitionBundle components

  • LA_ChatHeader — LA_ChatHeader — Not supported for AuraDefinitionBundle components

  • MIAW_Prechat — MIAW_Prechat

  • MIAW_Header — MIAW_Header

  • MIAW_TextMessage — MIAW_TextMessage

EmbeddedServiceConfigId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Introduced: API version 44.0

• Description: The unique ID of the EmbeddedServiceConfig object that this custom component is associated with.

• Relationship name: EmbeddedServiceConfig

• Relationship type: masterdetail

• Refers to: EmbeddedServiceConfig

Feature 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 44.0

• Description: The Embedded Service feature that uses the custom component.

• Possible values:

  • NotInUse — NotInUse

  • Base — Base

  • LiveAgent — LiveAgent

  • FieldService — FieldService

  • Flows — Flows

  • ChannelMenu — ChannelMenu

  • EmbeddedMessaging — EmbeddedMessaging

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.