EmbeddedServiceFlow

Represents a Flow Definition used by an Embedded Service deployment.

Version 

Introduced in API version 45.0.

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 

EmbeddedServiceConfigId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Description: The unique ID of EmbeddedServiceConfig (the Embedded Service deployment).

• Relationship name: EmbeddedServiceConfig

• Relationship type: masterdetail

• Refers to: EmbeddedServiceConfig

Feature 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: The Embedded Service feature that uses this flow. This is a read-only field.

• Possible values:

  • NotInUse — NotInUse

  • Base — Base

  • LiveAgent — LiveAgent

  • FieldService — FieldService

  • Flows — Flows

  • ChannelMenu — ChannelMenu

  • EmbeddedMessaging — EmbeddedMessaging

Flow 

• Type: picklist

• Required: No

• 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:

FlowType 

• Type: picklist

• Required: No

• 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:

  • FL_Flow — FL_Flow

  • FS_NewAppointment — FS_NewAppointment

  • FS_ModifyAppointment — FS_ModifyAppointment

  • FS_CancelAppointment — FS_CancelAppointment

  • LA_Survey — LA_Survey

IsAuthenticationRequired 

• Type: boolean

• Required: No

• 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.

• Default value: 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.