Skip to content

Schedule

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

Categories: helpers

Type: schedule/v1


Actions

Triggers

Every Day

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

Type: LISTENER

Properties

NameLabelTypeControl TypeDescriptionRequired
hourHourINTEGERINTEGERThe hour at which a workflow will be triggered.true
minuteMinuteINTEGERINTEGERThe minute at which a workflow will be triggered.true
dayOfWeekDay of Week{BOOLEAN(1), BOOLEAN(2), BOOLEAN(3), BOOLEAN(4), BOOLEAN(5), BOOLEAN(6), BOOLEAN(7)}OBJECT_BUILDERDays at which a workflow will be triggered.null
timezoneTimezoneSTRINGSELECTThe timezone at which the cron expression will be scheduled.null

Output

Type: OBJECT

Properties

NameTypeControl Type
datetimeSTRINGTEXT
hourINTEGERINTEGER
minuteINTEGERINTEGER
dayOfWeek{BOOLEAN(1), BOOLEAN(2), BOOLEAN(3), BOOLEAN(4), BOOLEAN(5), BOOLEAN(6), BOOLEAN(7)}OBJECT_BUILDER
timezoneSTRINGTEXT

Every Week

Trigger off at a specific day of the week.

Type: LISTENER

Properties

NameLabelTypeControl TypeDescriptionRequired
hourHourINTEGERINTEGERThe hour at which a workflow will be triggered.true
minuteMinuteINTEGERINTEGERThe minute at which a workflow will be triggered.true
dayOfWeekDay of WeekINTEGERSELECTDays at which a workflow will be triggered.true
timezoneTimezoneSTRINGSELECTThe timezone at which the cron expression will be scheduled.null

Output

Type: OBJECT

Properties

NameTypeControl Type
datetimeSTRINGTEXT
hourINTEGERINTEGER
minuteINTEGERINTEGER
dayOfWeekINTEGERINTEGER
timezoneSTRINGTEXT

Every Month

Trigger off at a specific time in month.

Type: LISTENER

Properties

NameLabelTypeControl TypeDescriptionRequired
hourHourINTEGERINTEGERThe hour at which a workflow will be triggered.true
minuteMinuteINTEGERINTEGERThe minute at which a workflow will be triggered.true
dayOfMonthDay of MonthINTEGERINTEGERThe day of the month at which a workflow will be triggered.true
timezoneTimezoneSTRINGSELECTThe timezone at which the cron expression will be scheduled.null

Output

Type: OBJECT

Properties

NameTypeControl Type
datetimeSTRINGTEXT
hourINTEGERINTEGER
minuteINTEGERINTEGER
dayOfMonthINTEGERINTEGER
timezoneSTRINGTEXT

Interval

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

Type: LISTENER

Properties

NameLabelTypeControl TypeDescriptionRequired
intervalIntervalINTEGERINTEGERThe hour at which a workflow will be triggered.true
timeUnitDay of WeekINTEGERSELECTDays at which a workflow will be triggered.true

Output

Type: OBJECT

Properties

NameTypeControl Type
datetimeSTRINGTEXT
intervalINTEGERINTEGER
timeUnitINTEGERINTEGER

Cron

Trigger off based on a custom schedule.

Type: LISTENER

Properties

NameLabelTypeControl TypeDescriptionRequired
expressionExpressionSTRINGTEXTThe chron schedule expression. Format: [Minute] [Hour] [Day of Month] [Month] [Day of Week]true
timezoneTimezoneSTRINGSELECTThe timezone at which the cron expression will be scheduled.null

Output

Type: OBJECT

Properties

NameTypeControl Type
datetimeSTRINGTEXT
expressionSTRINGTEXT
timezoneSTRINGTEXT