---
schema_version: "1"
id: 0d0647e8f0679ffcd4b3a1712660f9b6cf3c3e0ce900700f00731bf516221348
title: EmbeddedServiceFlow
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_embeddedserviceflow.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedserviceflow.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6d2f8d80abe7aaf9f356d45c8da9eacdd022c98b958f6823c9515a285a37fa45
description: Represents a Flow Definition used by an Embedded Service deployment. This object is available in API version 45.0 and later.
---
# 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](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_embeddedserviceconfig.htm "Represents a setup node for creating an Embedded Service deployment. Available in API version 38.0 and later.") (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](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_flowdefinition.htm "The parent of a set of flow versions.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_flowdefinition.htm "The parent of a set of flow versions.") executes a [Flow](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_flow.htm "Use the Flow object to retrieve and update specific flow versions.") 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.