Task Schedule object

_id

string

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

name

string

The name of task schedule. User can define task schedule name with task's flow name combined with running time, or something else.

periode

string

The period or frequency at which the task is scheduled.

flow

string

The flow or process associated with this task schedule.

flowId

string

The identifier id of flow associated with this task schedule.

task

object

Details of the task to be performed.

assignee

string[]

List of email that has been assigned the task.

startTime

string

The start date of the task schedule.

endTime

string

The end date of the task schedule.

schedules

object[]

Specific time(s) at which the task is scheduled to occur.

Show child attributes

schedules.time

string

Time of the task schedule will be executed.

schedules.day

string

Day of the task schedule will be executed.

schedules.date

string

Date of the task schedule will be executed.

timeSchedules

string[]

Time schedule data has a certain format based on schedules which are generated by the system.

logExecuted

object

Logs related to the execution of this task schedule. It includes details such as the execution status, task ID, message, and last execution time.

Show child attributes

logExecuted.status

string

The last status of task scheduler. Indicates the current status of the scheduled task. Available values are: PENDING : The task scheduler has been created and is waiting to be processed SUCCESS : The task was successfully created by the task scheduler FAILED : The task failed to create by the task scheduler

logExecuted.taskId

string

The last generated taskId of executed schedule.

logExecuted.message

array

List of messages from last executed schedule.

logExecuted.lastExecute

string

The last timestamp of executed schedule.

hubId

string

Identifier for the hub that owns or manages the task schedule.

organizationId

string

Identifier for the organization or company that owns or manages the task schedule.

updatedBy

string

The email associated with the user whose update this schedule data.

createdBy

string

The email associated with the user whose create this schedule data.

updatedTime

string<date-time>

Timestamp represents the date and time when this schedule data was updated.

createdTime

string<date-time>

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

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects