Flow object

_id

string

An unique identifier for the flow record, often used for database or system reference.

organizationId

string

Identifier for the organization or company that owns or manages the flow.

name

string

The name of flow. Name must be unique at organization. When creating a flow, you cannot use the flow with the name Handover because it has been used as a reserved key.

pages

object[]

Settings that will define the detail information of flow structure.

Show child attributes

pages.id

string

An unique identifier for the flow pages. Usually this id used as order page.

pages.components

object[]

An object containing detail information and configuration for components.

Show child attributes

pages.components.id

string

An unique identifier for flow component. The value that cannot be input is the reserved key task. To see the details of reserved key of task, please follow this link

pages.components.component

string

Type of Component. There are 10 types of component:select,input,photo,signature,view,bill,list,timer,voice,capture

pages.components.title

string

Title of Component.

pages.components.inputType

string

The input type of the component (e.g., string, number, date, etc.)

pages.components.default

string

Default Value of Component.

pages.components.value

string

Component values will be displayed in other components.Field only exist, if component is view or bill or list

pages.components.routeAs

string

Flag trigger of routing data.There are 8 types of routeAs: VisitName,Address,OpenTime,CloseTime,VisitDuration,Coordinate,Tag,Constraint.weight

pages.components.showAs

string

Flag trigger to display data in the task list. The value of component, which will appear on task pages on the web and apps. There are 3 types of showAs: title,content,label

pages.components.isRequired

boolean

Flag that mark field as required or not on flow component.

pages.components.visible

boolean

Flag on flow component that will make task field visible or not.

pages.components.useUnit

boolean

To set input type number using unit. Field only exist, if component is number

pages.components.units

string[]

Value of units for input type number component. Field only exist, if component is number and useUnit is true

pages.components.useGeoLock

boolean

Flag Trigger of geolock feature on mobile devices. Field only exist, if component is coordinate

pages.components.radius

integer

Distance in units (m) to use geolock. Field only exist, if component is coordinate

pages.components.geoLockTrigger

string

Trigger to determine when the geolock will be used. There are 2 types of geoLockTrigger: onTaskDone,onTaskStart. Field only exist, if component is coordinate

pages.components.useGeocode

boolean

To set coordinate use geocode. Field only exist, if component is coordinate

pages.components.geocodeAs

string

To reference geocode use the address component id. Field only exist, if component is coordinate and useGeocode is true

pages.components.onSelect

object[]

Detailed object data of the selected event. Field only exist, if component is select

Show child attributes

pages.components.onSelect.options

string[]

Option on select component that when it is selected will trigger an action.

pages.components.onSelect.action

string

Desired action if that option is selected. There are 3 types of action: show,hide,fill

pages.components.onSelect.componentAffected

string[]

Components that will be affected by the selected action. There are 7 types of componentAffected: text, date, dateTime, time, number, address, coordinate.

pages.components.options

string[]

Detail value of select component.

pages.components.min

integer

Minimum value of component. Field only exist, if component is select or photo

pages.components.max

integer

Maximum value of component. Field only exist, if component is select or photo

pages.components.categories

string[]

Value of category for photo component. Field only exist, if component is photo

pages.components.watermark

boolean

Configuration for users to enable watermark on photos when creating tasks. The default value of the watermark is false. Field only exist, if component is photo

pages.components.addNew

boolean

Configuration to allow users to add new items to the task bill or task list. Field only exist, if component is bill or list

pages.components.addNewType

string

Way to add a new list. There are 2 types of addNewType: input,select. Field only exist, if component is list.

pages.components.addNewData

object[]

Detailed list of item names. Field only exist, if component is list and addNewType is select

pages.components.addNewValidationType

string

Configuration to set the data type validation used. There are 5 types of addNewValidationType: noValidation,text,number,textAndNumber,custom. Field only exist, if component is list and addNewType is input.

pages.components.addNewValidation

string

Regex validation details following addNewValidationType. Field only exist, if component is list and addNewType is input.

pages.components.masterItems

object[]

Detail data object of the master items contain name andunit_price. Field only exist, if component is bill

Show child attributes

pages.components.masterItems.name

string

Name of the bill item.

pages.components.masterItems.unit_price

integer

Price of the bill item.

pages.components.masterCosts

object[]

Detail data object of the master costs contain type,name and amount. Field only exist, if component is bill

Show child attributes

pages.components.masterCosts.name

string

Name of bill cost.

pages.components.masterCosts.inputType

string

The input type of the component (e.g., string, number, date, etc.)

pages.components.masterCosts.amount

integer

Amount of bill cost .

pages.components.costs

string[]

Cost data available on the billing component. Field only exist, if component is bill

pages.components.useDataSource

boolean

Configuration to use the data source as a item in the selected component. Field only exist, if component is list or bill

pages.components.autoStart

boolean

Configuration to initiate the time when users open a task on a mobile device. Field only exist, if component is timer

pages.components.reset

boolean

Configuration to enable the reset function of the timer on mobile device. Field only exist, if component is timer

pages.components.unpausable

boolean

Configuration to remove the pause timer function on mobile device. Field only exist, if component is timer

pages.components.maxDuration

integer

The maximum time configuration for using the voice component ranges from 0 to 10 minutes. Field only exist, if component is voice

configurations

object[]

An object containing various configuration settings for advance setting of the flow.

Show child attributes

configurations.id

string

ID of configuration. There are 3 types of id : startTime,endTime,dataSource

configurations.adjustment

string

Value of configuration adjusment. Field only exist, if id is startTime and endTime

configurations.list

object[]

Detail configuration of mapping data source to flow. Field only exist, if id is dataSource.

Show child attributes

configurations.list.typeId

string

Unique identifier key for reference to data type.

configurations.list.fields

object[]

Data type field for mapping to flow component.

Show child attributes

configurations.list.fields.id

string

Fields from the data source.

configurations.list.fields.title

string

Title from the data source.

configurations.list.fields.inputType

string

The input type of the component (e.g., string, number, date, etc.)

configurations.list.fields.componentId

string

ID of component

configurations.list.fields.primaryKey

boolean

A primary key is a unique identifier from the data source. One data source only has one primary key.

isDefault

boolean

Indicating whether the flow is marked as default (false means it's not default).

orderIndex

integer

Identifier to order flow. User can define it by number value.

version

integer

Version of flow. The version will increase when the user makes changes to the flow.

createdBy

string

A user email, representing the user who created flow.

updatedBy

string

A user email, representing the user who updated flow.

createdTime

string<date-time>

Timestamp represents the date and time when this flow data was initially created.

updatedTime

string<date-time>

Timestamp represents the last time the flow data was updated. It includes date and time information.

failedCode

enum<string>

Flow Management Module business codes that indicate specific failure conditions or business rule violations during flow operations. These codes help identify the exact nature of flow-related failures and provide standardized failure identification across the system.

Possible values:

flow-031: Duplicate entry - Flow name already exists
flow-032: Invalid state/condition - Flow state invalid
flow-033: Flow not found - Flow does not exist
flow-034: Flow validation failed - Invalid flow structure
flow-035: Access forbidden - User lacks flow permission
flow-036: Flow creation failed - Failed to create flow
flow-037: Flow update failed - Failed to update flow
flow-038: Flow delete failed - Failed to delete flow
flow-039: Component failure - Invalid component configuration
flow-040: Version conflict - Flow version mismatch
flow-041: Dependency failure - Missing required dependencies
flow-042: Template failure - Invalid flow template
flow-043: License failure - Flow feature not in license
flow-044: Export failure - Failed to export flow
flow-045: Server failure - Internal server failure

Available options:

flow-031,

flow-032,

flow-033,

flow-034,

flow-035,

flow-036,

flow-037,

flow-038,

flow-039,

flow-040,

flow-041,

flow-042,

flow-043,

flow-044,

flow-045

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

File

Billing

Dashboard

Authentication

Reference

Internal Tools

Objects