Data type object

_id

string

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

name

string

Name of the data type, which is used to identify and reference it.

fields

object[]

Array of data type fields.

Show child attributes

fields.id

string

Identifier for the field and is used to reference it in the data type.

fields.primaryKey

boolean

A primary key is a unique identifier for each record in the data type, and it helps in distinguishing and retrieving specific records.

fields.isRequired

boolean

This indicates that data in this field is mandatory or not. When someone is entering data into this data source, they must provide a value for this field or not.

fields.title

string

Human-readable label or title for the field, which describes what kind of data this field holds.

fields.description

string

fields.inputType

string

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

fields.default

string

Default value of field.

fields.show

string

Once set into true, field will be shown when someone create data source.

fields.optionData

object[]

If data type is option, list of option will be saved in this key.

limitUser

boolean

Setting to limit data source usage by users. If the value is true, only specific users can view the data source. and if the value is false, all users can view the data source.

commonData

boolean

By default the data source is unique by hub, but if the commonData configuration value is true, the data source is unique by organization. This setting is not changeable after creation.

createdBy

string

A user email, representing the user who created data type.

updatedBy

string

A user email, representing the user who updated data type.

organizationId

string

Identifier for the organization or company that owns or manages the data type.

updatedTime

string<date-time>

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

createdTime

string<date-time>

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

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects