---
schema_version: "1"
id: 883f45261ab939622c4ebb32008986ead7a5c2bf5ab3c9710ab78a832ed8a2ad
title: EmbeddedServiceCustomComponent
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_embeddedservicecustomcomponent.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedservicecustomcomponent.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: b468e0c65e93aaf057a9a26adb64ea0749ef1f0fb0e72f6007e6a0dcd400e753
description: 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.
---
# 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](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_lightningcomponentbundle.htm "Represents a Lightning web component bundle. A bundle contains a Lightning web component and its related resources. Available in API version 45.0 and later.") or [AuraDefinitionBundle](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_auradefinitionbundle.htm "Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. Available in API version 32.0 and later.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_auradefinitionbundle.htm "Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. Available in API version 32.0 and later.") components
- LA\_Minimized
- LA\_PlainTextChatMessage—Not supported for [AuraDefinitionBundle](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_auradefinitionbundle.htm "Represents a Lightning Aura component definition bundle, such as a component or application bundle. A bundle contains a Lightning Aura component definition and all its related resources. Available in API version 32.0 and later.") components
- LA\_Prechat





 |
| EmbeddedServiceConfigId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

The unique ID of the [EmbeddedServiceConfig](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedserviceconfig.htm "Represents a setup node for creating an Embedded Service deployment. Available in API version 38.0 and later.") 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.