EmbeddedServiceFieldService

Represents a setup node for creating a Snap-ins Appointment Management deployment. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

EmbeddedServiceFieldService components are stored in a developer_name.EmbeddedServiceFieldService file in the EmbeddedServiceFieldService folder.

Version

EmbeddedServiceLiveAgent is available in API version 43.0 and later.

Fields

Field Name	Field Type	Description
appointmentBookingFlowName	string	Name of the appointment booking flow for this Snap-ins Appointment Management (beta) deployment.
cancelApptBookingFlowName	string	Name of the appointment cancellation flow for this Snap-ins Appointment Management (beta) deployment.
embeddedServiceConfig	string	Required. The name of the embedded service configuration node.
enabled	boolean	Required. Indicates whether this Snap-ins Appointment Management deployment is enabled (`true`).
fieldServiceConfirmCardImg	string	URL of the image used for the confirmation card in Snap-ins Appointment Management (beta).
fieldServiceHomeImg	string	URL of the image used for the home screen in Snap-ins Appointment Management (beta).
fieldServiceLogoImg	string	URL of the logo used for the home screen in Snap-ins Appointment Management (beta).
masterLabel	string	Required. Name of the Snap-ins Appointment Management (beta) deployment.
modifyApptBookingFlowName	string	Name of the appointment modification flow for this Snap-ins Appointment Management (beta) deployment.
shouldShowExistingAppointment	boolean	Specifies whether to display a button on the home screen for customers to access their existing appointments (`true`) or not (`false`). This field is `false` by default.
shouldShowNewAppointment	boolean	Specifies whether to display a button on the home screen for customers to create a new appointment (`true`) or not (`false`). This field is `false` by default.

Declarative Metadata Sample Definition

The following is an example of an EmbeddedServiceFieldService file.

1<?xml version="1.0" encoding="UTF-8"?>
2<EmbeddedServiceFieldService xmlns="http://soap.sforce.com/2006/04/metadata">
3    <appointmentBookingFlowName>ESW_FS_BookAppt_Main_Flow</appointmentBookingFlowName>
4    <cancelApptBookingFlowName>ESW_FS_CancelAppt_Flow</cancelApptBookingFlowName>
5    <embeddedServiceConfig>EswFS</embeddedServiceConfig>
6    <enabled>true</enabled>
7    <fieldServiceConfirmCardImg>https://google.com/AppointmentConfirmationImg.png</fieldServiceConfirmCardImg>
8    <fieldServiceHomeImg>https://google.com/HeroImg.png</fieldServiceHomeImg>
9    <fieldServiceLogoImg>https://google.com/logo.png</fieldServiceLogoImg>
10    <masterLabel>EmbeddedServiceFieldService_Parent04IRM000000007p2AA_162d4270834</masterLabel>
11    <modifyApptBookingFlowName>ESW_FS_ModifyAppt_Main_Flow</modifyApptBookingFlowName>
12    <shouldShowExistingAppointment>true</shouldShowExistingAppointment>
13    <shouldShowNewAppointment>true</shouldShowNewAppointment>
14</EmbeddedServiceFieldService>

Usage

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.

Note

Metadata API Developer Guide