EmbeddedServiceFlow

Represents a Flow Definition used by an Embedded Service deployment. This object is available in API version 45.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

To access this type, you need the Customize Application user permission.

Fields

Field	Details
EmbeddedServiceConfigId	Type reference Properties Create, Filter, Group, Sort Description The unique ID of EmbeddedServiceConfig (the Embedded Service deployment).
Feature	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The Embedded Service feature that uses this flow. This is a read-only field. Possible values are: `FieldService` `Flows` `LiveAgent`
Flow	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The flow definition name. Use one of the listed standard flows or an ID of a FlowDefinition that you created. Possible standard flow values are: `runtime_sales_see__SEE` `setup_service_experience__Create_Case` `setup_service_experience__Verify_Cust`
FlowType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The flow type used in a Flow (FL), Appointment Booking (FS), or Chat (LA) feature of Embedded Service. Possible values are: `FL_Flow` `FS_CancelAppointment` `FS_ModifyAppointment` `FS_NewAppointment` `LA_Survey`
IsAuthenticationRequired	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Specifies whether authentication is required for this flow (`true`) or not (`false`). Authentication is required if the FlowType is an Appointment Booking type. Default is `false`.

Usage

The EmbeddedServiceFlow specifies which FlowDefinitions are used by the Embedded Service features Appointment Booking, Chat, and Flow. A FlowDefinition executes a Flow object. A FlowDefinition can have more than one version of a Flow object but only the active one is executed.

Only certain ProcessType values of the Flow object are supported depending on which FlowType you select in the EmbeddedServiceFlow object.

Appointment Booking features, where the FlowType starts with “FS”, only support FieldServiceWeb and Appointments values for ProcessType.
Chat features, where the FlowType starts with “LA”, only support the Flow value for ProcessType.
Flow features, where the FlowType starts with “FL”, only support the Survey value for ProcessType.