Automation object

_id

string

Unique identifier for the automation that generated by system.

name

string

The name of automation.

event

string

Act as a trigger that start an automation. There are 4 different types onTaskCreated: Automation will happen when a task is created. onTaskFinished: Automation will happen when a task is finished (status task: Done). onTaskAssigned: Automation will happen when a task is assigned to field user(s). onDataSourceCreated: Automation will happen when a datasource is created.

automationType

string

Automation's type. The changes you want to automate. There are 6 different types: createTask: The task will create when an event happens. createAssignTask: will create assigned task when an event happens. moveTask: The task will move to the selected hub when an event happens. assignTask: The task will automatically assigned to the selected user on a hub when an event happens. webhook: The data task or data source will sent to the specific URL when an event happens. createOrUpdateDataSource: The data source will create or update when an event happens.

dataType

string

Automation's data type to describe that automation is running on a task or data module.

automationDetails

object

Set of fields according to the selected automation type.

Show child attributes

automationDetails.flow

string

FlowName to select specific task format to be created on automation event. When creating or updating a automation, you cannot use the flow with the name Handover because it has been used as a reserved key. Field only exist, if automationType is createTask and createAssignTask

automationDetails.flowId

string

Identifier of Flow to select specific task for event to happens. When creating or updating a automation. flowId is required for dataType is task and all automationType value.

automationDetails.taskData

object[]

The task will be created with the given data (different flow may have different sets of field). Field only exist, if automationType is createTask and createAssignTask The value can be set as static value such as: 'Jakarta'. or set as dynamic value according to rules.flow such as : '$refFlow.name'

automationDetails.hubId

string

Hub identifier to define task location when an event happens. Field only exist, if automationType is moveTask and createAssignTask. To use a dynamic hub, you can utilize the hubId with the value $refFlow.hubId in the createAssignTask type.

automationDetails.assignee

object[]

List of email that has been assigned the task. Worker's email that assigned to the task. One task can be assigned by multiple worker. Field only exist, if automationType is assignTask and createAssignTask

automationDetails.reassignment

string

Type of reassigment that will be auto assign when user created task. Field only exist, if event is onTaskFinished or onTaskCreated and automationType is createAssignTask. There are 3 types of reassigment if event is onTaskFinished :assignee,assignedBy,doneBy. and there are 2 type of reassigment if event is onTaskCreated :assignee,assignedBy.

automationDetails.url

string

The address that payloads are sent to. Field only exist, if automationType is webhook

automationDetails.headers

object[]

Used to to provide additional information when default headers are not enough then they can use a custom header configuration. Field only exist, if automationType is webhook

automationDetails.dataTypeId

string

Data Type Id to select specific data source format to be executed on automation event. Field only exist, if automationType is createOrUpdateDataSource

automationDetails.dataTypeName

string

Data Type Name is not required. our system will set the value according to dataTypeId.

automationDetails.dataId

string

Data Id to select specific flow's component id format to be executed on automation event. Field only exist, if automationType is createOrUpdateDataSource. Value can be set as dynamic values according to the data source that has been mapped with the flow such as : $refFlow.pickupNumber

automationDetails.dataSource

object[]

The data source will be created or updated with the given data (different data type id may have different sets of field). Field only exist, if automationType is createOrUpdateDataSource. The value can be set as static value such as: 'Jakarta'. or set as dynamic value according to rules.flow such as : '$refFlow.phoneNumber'

automationDetails.updateLimitUser

boolean

Configuration to run automation using user limit. If updateLimitUser has a value of true, users can execute automation using either 'limitUser' or 'limitType'. And if updateLimitUser has a value of false, the automation will run without using a user limit.Field only exist, if automationType is createOrUpdateDataSource.

automationDetails.replaceLimitUser

boolean

Configuration to replace the current user limit. If replaceLimitUser is set to true, the automation will replace the existing user limit using either limitUser or limitType. If replaceLimitUser is set to false, the automation will run without modifying the existing user limit. This field only exists if automationType is createOrUpdateDataSource. Note: updateLimitUser and replaceLimitUser cannot both be set to true at the same time.

automationDetails.limitUser

string[]

Data source automation will be created using user restrictions based on user emails in the same organization or can be empty if the data source can be accessed by all users. Field only exist, if automationType is createOrUpdateDataSource and updateLimitUser or replaceLimitUser is true.

automationDetails.limitType

string

Data source automation will be created using user restrictions determined based assignee, assignedBy and doneBy when completing a task. Field only exist, if automationType is createOrUpdateDataSource and updateLimitUser or replaceLimitUser is true.

rules

object

Act as an automation's criteria. Criteria that must be true to run an Automation.

Show child attributes

rules.flow

string

FlowName to select specific task for event to happens. When creating or updating a automation, you cannot use the flow with the name Handover because it has been used as a reserved key. flow is required for dataType is task and all automationType value.

rules.flowId

string

Identifier of Flow to select specific task for event to happens. When creating or updating a automation. flowId is required for dataType is task and all automationType value.

rules.dataTypeId

string

DataTypeId to select specific data source for event to happens. dataTypeId is required for dataType is data and automationType is createTask or webhook

rules.fields

object

Example for dataType 'task' Additional automation's filter. Use GET /flow-fields API to get the list of structure data. fields is required for all automationType value except webhook. Example: { 'name':'roger', 'address':'kemayoran' }

Example for dataType 'data' Use GET /data-types API to get the list of structure data. fields is required for automationType is createTask. Example: { 'name':'roger', 'address':'kemayoran' }

rules.schema

string

A combination of rules.flow and rules.fields generated by the system.

organizationId

string

The identifier for the organization that generated by system.

isActive

boolean

Automation's active state, only active automation will proceed by system

createdTime

string<date-time>

Time at which the automation was created.

updatedTime

string<date-time>

Time at which the automation was updated.

createdBy

string

Email that created the automation.

updatedBy

string

Email that updated the automation.

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects