EmbeddedServiceLiveAgent

Represents a setup node for creating a Snap-ins Chat Live Agent deployment. Available in Tooling API version 38.0 and later.

Supported Calls

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

Supported REST HTTP Methods

REST HTTP isn’t supported in version 38.0.

Fields

Field	Details
CustomPrechatComponent	Type AuraDefinitionBundle Properties Nillable Description The custom Lightning Component that’s used for the pre-chat page in this Snap-ins Chat deployment.
CustomPrechatComponentId	Type ID Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the custom Lightning Component that’s used for the pre-chat page in this Snap-ins Chat deployment.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description Unique name for the Snap-ins Chat configuration setup node.
EmbeddedServiceConfigID	Type reference Properties Create, Filter, Group, Sort, Update Description Unique name for the Snap-ins Chat deployment ID.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Languages supported in the Snap-ins Chat Live Agent deployment. Chinese (Simplified): `zh_CN` Chinese (Traditional): `zh_TW` Danish: `da` Dutch: `nl_NL` English: `en_US` Finnish: `fi` French: `fr` German: `de` Italian: `it` Japanese: `ja` Korean: `ko` Norwegian: `no` Portuguese (Brazil): `pt_BR` Russian: `ru` Spanish: `es` Spanish (Mexico): `es_MX` Swedish: `sv` Thai: `th`
LiveChatButtonId	Type reference Properties Create, Filter, Nillable, Sort, Update Description Reference to a chat button created in the Live Agent setup.
LiveChatDeploymentId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reference to a deployment created in the Live Agent setup.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description Name of the Snap-ins Chat Live Agent deployment.
PreChatEnabled	Type boolean Properties Create, Filter, Group, Sort, Update Description Indicates whether the Snap-ins pre-chat form is enabled for this chat deployment.
Scenario	Type picklist Properties Create, Filter, Group, Sort, Update Description The type of use case that is selected for the Snap-ins pre-chat form. Valid values are: `Basic` `Sales` `Service`

Usage

EmbeddedServiceLiveAgent represents a Live Agent configuration that is added to your web page. The EmbeddedServiceLiveAgent record contains a unique combination of a Live Agent chat button and the Live Agent deployment that the administrator selects during setup.

To create an EmbeddedServiceLiveAgent record, creat a Live Agent Deployment, Live Agent Chat Button, and EmbeddedServiceConfig record. Then, set the fields for these records as references on the EmbeddedServiceLiveAgent record.