Schedule

With the Scheduled trigger, you can initiate customized workflows at specific time intervals.

Categories: helpers

Type: schedule/v1

---

Triggers

Every Day

Name: everyDay

Trigger off at a specific time either on a daily basis or selected days of the week.

Type: LISTENER

Properties

Name	Label	Type	Description	Required
hour	Hour	INTEGER	The hour at which a workflow will be triggered.	true
minute	Minute	INTEGER	The minute at which a workflow will be triggered.	true
dayOfWeek	Day of Week	ARRAY Items [INTEGER]	Days at which a workflow will be triggered.	true
timezone	Timezone	STRING Options Etc/GMT+0, Etc/GMT-1, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT+1, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12	The timezone at which the cron expression will be scheduled.	true

Output

Type: OBJECT

Properties

Name	Type	Description
datetime	STRING	The exact date and time when the trigger was activated, formatted according to the specified timezone.
hour	INTEGER	The hour of the day (0-23) at which the workflow was set to trigger.
minute	INTEGER	The minute of the hour (0-59) at which the workflow was set to trigger.
dayOfWeek	ARRAY Items [INTEGER]	The specific days of the week (represented as integers) on which the workflow was set to trigger.
timezone	STRING	The timezone used for scheduling the cron expression, ensuring the trigger fires at the correct local time.

JSON Example

{
  "label" : "Every Day",
  "name" : "everyDay",
  "parameters" : {
    "hour" : 1,
    "minute" : 1,
    "dayOfWeek" : [ 1 ],
    "timezone" : ""
  },
  "type" : "schedule/v1/everyDay"
}

Every Week

Name: everyWeek

Trigger off at a specific day of the week.

Type: LISTENER

Properties

Name	Label	Type	Description	Required
hour	Hour	INTEGER	The hour at which a workflow will be triggered.	true
minute	Minute	INTEGER	The minute at which a workflow will be triggered.	true
dayOfWeek	Day of Week	INTEGER Options 1, 2, 3, 4, 5, 6, 7	Days at which a workflow will be triggered.	true
timezone	Timezone	STRING Options Etc/GMT+0, Etc/GMT-1, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT+1, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12	The timezone at which the cron expression will be scheduled.	true

Output

Type: OBJECT

Properties

Name	Type	Description
datetime	STRING	The exact date and time when the trigger was activated, formatted according to the specified timezone.
hour	INTEGER	The hour of the day (0-23) at which the workflow was set to trigger.
minute	INTEGER	The minute of the hour (0-59) at which the workflow was set to trigger.
dayOfWeek	INTEGER	The day of the week (represented as integers) on which the workflow was set to trigger.
timezone	STRING	The timezone used for scheduling the cron expression, ensuring the trigger fires at the correct local time.

JSON Example

{
  "label" : "Every Week",
  "name" : "everyWeek",
  "parameters" : {
    "hour" : 1,
    "minute" : 1,
    "dayOfWeek" : 1,
    "timezone" : ""
  },
  "type" : "schedule/v1/everyWeek"
}

Every Month

Name: everyMonth

Trigger off at a specific time in month.

Type: LISTENER

Properties

Name	Label	Type	Description	Required
hour	Hour	INTEGER	The hour at which a workflow will be triggered.	true
minute	Minute	INTEGER	The minute at which a workflow will be triggered.	true
dayOfMonth	Day of Month	INTEGER	The day of the month at which a workflow will be triggered.	true
timezone	Timezone	STRING Options Etc/GMT+0, Etc/GMT-1, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT+1, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12	The timezone at which the cron expression will be scheduled.	true

Output

Type: OBJECT

Properties

Name	Type	Description
datetime	STRING	The exact date and time when the trigger was activated, formatted according to the specified timezone.
hour	INTEGER	The hour of the day (0-23) at which the workflow was set to trigger.
minute	INTEGER	The minute of the hour (0-59) at which the workflow was set to trigger.
dayOfMonth	INTEGER	The specific day of the month (1-31) on which the workflow was set to trigger.
timezone	STRING	The timezone used for scheduling the cron expression, ensuring the trigger fires at the correct local time.

JSON Example

{
  "label" : "Every Month",
  "name" : "everyMonth",
  "parameters" : {
    "hour" : 1,
    "minute" : 1,
    "dayOfMonth" : 1,
    "timezone" : ""
  },
  "type" : "schedule/v1/everyMonth"
}

Interval

Name: interval

Trigger off periodically, for example every minute or day, based on a set interval.

Type: LISTENER

Properties

Name	Label	Type	Description	Required
interval	Interval	INTEGER	Specifies the frequency at which the workflow is triggered, based on the selected time unit. For example, an interval of 5 with a time unit of ‘Minute’ triggers the workflow every 5 minutes.	true
timeUnit	Time Unit	INTEGER Options 1, 2, 3, 4	Specifies the unit of time used in conjunction with the interval to determine the frequency of workflow triggers.	true

Output

Type: OBJECT

Properties

Name	Type	Description
datetime	STRING	The exact date and time when the trigger was activated, formatted according to the specified timezone.
interval	INTEGER	The interval value that determines how frequently the workflow is triggered, based on the selected time unit.
timeUnit	INTEGER	The unit of time (e.g., minute, hour, day, month) used in conjunction with the interval to schedule the trigger.

JSON Example

{
  "label" : "Interval",
  "name" : "interval",
  "parameters" : {
    "interval" : 1,
    "timeUnit" : 1
  },
  "type" : "schedule/v1/interval"
}

Cron

Name: cron

Trigger off based on a custom schedule.

Type: LISTENER

Properties

Name	Label	Type	Description	Required
expression	Expression	STRING	The chron schedule expression. Format: [Minute] [Hour] [Day of Month] [Month] [Day of Week]	true
timezone	Timezone	STRING Options Etc/GMT+0, Etc/GMT-1, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT+1, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12	The timezone at which the cron expression will be scheduled.	true

Output

Type: OBJECT

Properties

Name	Type	Description
datetime	STRING	The exact date and time when the trigger was activated, formatted according to the specified timezone.
expression	STRING	The cron schedule expression that defines the timing pattern for triggering the workflow.
timezone	STRING	The timezone used for scheduling the cron expression, ensuring the trigger fires at the correct local time.

JSON Example

{
  "label" : "Cron",
  "name" : "cron",
  "parameters" : {
    "expression" : "",
    "timezone" : ""
  },
  "type" : "schedule/v1/cron"
}

---