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
AvatarImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used as the agent avatar image.
CancelApptBookingFlowName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of the appointment cancellation flow for Snap-ins Appointment Management (beta).
ContrastInvertedColor
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Accent branding color used in the snap-in, displayed as a hexadecimal value. Changes made to this field in the API aren’t reflected in the snap-in.
ContrastPrimaryColor
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Value of the ContrastPrimaryColor field in the EmbeddedServiceBranding setup object.
CustomMinimizedComponent
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The custom Lightning component that’s used for the minimized snap-in for this Snap-ins Chat deployment.
CustomPrechatComponent
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The custom Lightning component that’s used for the pre-chat page for this Snap-ins Chat deployment.
DurableID
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Developer name for the EmbeddedServiceConfig.
FieldServiceConfirmCardImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the confirmation card in Snap-ins Appointment Management (beta).
FieldServiceHomeImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the home screen in Snap-ins Appointment Management (beta).
FieldServiceLogoImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the logo used for the home screen in Snap-ins Appointment Management (beta).
FlowDeveloperName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The developer name of the flow used to create a new appointment in Snap-ins Appointment Management (beta).
Font
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Font used in the chat text of the Snap-ins chat widget.
FontSize
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Font size for the snap-in.
Possible values are:
  • Small
  • Medium
  • Large
HeaderBackgroundImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the header background in Snap-ins Chat.
Height
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Height of the snap-in.
IsFieldServiceEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether Field Service is enabled for this Snap-ins deployment (true) or not (false). Snap-ins Appointment Management is currently beta.
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).
IsOfflineCaseEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether offline support 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.
IsQueuePositionEnabled
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether queue position (displaying the customer’s place in line while they wait for an agent) is enabled for this Snap-ins Chat deployment (true) or not (false).
ModifyApptBookingFlowName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of the flow used for modifying an existing appointment for Snap-ins Appointment Management (beta).
NavBarColor
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Value of the NavBarColor field in the EmbeddedServiceBranding setup object.
OfflineCaseBackgroundImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the background for the offline support case form in Snap-ins Chat.
PrechatBackgroundImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the background for the pre-chat form in Snap-ins Chat.
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.
ShouldHideAuthDialog
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether the prompt that the customer log in again during a flow should be hidden (true) or not (false). When it’s hidden, the customer is taken directly to your login page.
ShouldShowExistingAppointment
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether to display a button on the home screen for customers to access their existing appointments (true) or not (false) for Snap-ins Appointment Management (beta).
ShouldShowNewAppointment
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Specifies whether to display a button on the home screen for customers to create a new appointment (true) or not (false) for Snap-ins Appointment Management (beta).
Site
Type
string
Properties
Filter, Group, Nillable Sort
Description
Value of the Site field in the EmbeddedServiceConfig setup object.
SmallCompanyLogoImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the logo image used with Snap-ins Chat.
WaitingStateBackgroundImg
Type
string
Properties
Filter, Group, Nillable, Sort
Description
URL of the image used for the background image in Snap-ins Chat while the customer waits to be connected with a support agent.
Width
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Width of the snap-in.
Note

Note

Any changes you make to the image fields override what you’ve entered in Setup. We recommend setting your Snap-ins image URLs in Setup.