EmbeddedServiceDetail

Represents a metadata catalog object that exposes fields from the underlying Embedded Service setup objects defined in each EmbeddedServiceConfig deployment for guest users. Guest users don’t have direct access to the Embedded Service setup objects. Available in API version 39.0 and later.

Supported SOAP Calls

describeSObjects(), query()

Supported REST HTTP Methods

GET

Fields

Field	Details
ContrastPrimaryColor	Type string Properties Filter, Group, Nillable, Sort Description Value of the ContrastPrimaryColor field in the EmbeddedServiceBranding setup object.
CustomPrechatComponent	Type string Properties Filter, Group, Nillable, Sort Description The custom Lightning Component that’s used for the pre-chat page in this Snap-ins Chat deployment.
DurableID	Type string Properties Filter, Group, Nillable, Sort Description Developer name for the EmbeddedServiceConfig.
Font	Type string Properties Filter, Group, Nillable, Sort Description Font used in the chat text of the Snap-ins chat widget.
IsLiveAgentEnabled	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether Live Agent is enabled for this Snap-ins deployment (`true`) or not (false).
IsPreChatEnabled	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Value of the PreChatEnabled field in the EmbeddedServiceLiveAgent setup object.
NavBarColor	Type string Properties Filter, Group, Nillable, Sort Description Value of the NavBarColor field in the EmbeddedServiceBranding setup object.
PrimaryColor	Type string Properties Filter, Group, Nillable, Sort Description Value of the PrimaryColor field in the EmbeddedServiceBranding setup object.
SecondaryColor	Type string Properties Filter, Group, Nillable Sort Description Value of the SecondaryColor field in the EmbeddedServiceBranding setup object.
Site	Type string Properties Filter, Group, Nillable Sort Description Value of the Site field in the EmbeddedServiceConfig setup object.

The following fields are visible but unusable.

AvatarImg
ContrastInvertedColor
FontSize
HeaderBackgroundImg
PrechatBackroundImg
SmallCompanyLogoImg
WaitingStateBackgroundImg

The following fields are visible but unavailable except for Snap-ins Appointment Booking pilot users:

CancelApptBookingFlowName
FieldServiceConfirmCardImg
FieldServiceHomeImg
FieldServiceLogoImg
FlowDeveloperName
IsFieldServiceEnabled
ModifyApptBookingFlowName
ShouldShowExistingAppointment
ShouldShowNewAppointment

Object Reference for Salesforce and Force.com

EmbeddedServiceDetail

Supported SOAP Calls

Supported REST HTTP Methods

Fields