Skip to main content Skip to footer

Scheduler Documentation

Version: 1.2.1

Retrieved: 2025-10-09 15:16:17


Scheduler

This module sends a message at the scheduled times by matching a time pattern against the system clock (UTC wall-clock time).

The time pattern is based on the syntax used by the cron command to allow repetitive schedules to be defined by matching patterns against different time units, e.g. seconds, minutes and hours. For more information on the supported syntax see below.

This module is intended to be used at the beginning of a flow.

Settings

Name Requirements Purpose Default
Target Property Length: 0-64 The property to write the result into. If empty result is written to the root data
Value Nullable Boolean The value of the result None
Run on start Boolean Sends a message when the flow is started true
Start Value Nullable Boolean The value of the start message None
Second Number or Valid Cron Syntax The second to run on *
Minute Number or Valid Cron Syntax> The minute to run on *
Hour Number or Valid Cron Syntax The hour to run ony *
Minute Number or Valid Cron Syntax The day of month to run on *
Month Number or Valid Cron Syntax> The month to run on *
Day of week Number or Valid Cron Syntax> The day of week to run on *

Basic cron syntax

The settings you enter for each of the time units is a pattern that will be matched against the actual values. The basic syntax for these patterns is:

* Matches any value
Number Matches a specific value
Number, Number Matches the listed values
Number-Number Matches a range of values

For example, to generate a message at the top of the hour: Set Minutes=0 and leave all other patterns as *. If you only want to generate messages on working days you can add Weekdays=1-5 to the above.

With * and ranges you can also use / to specify a step, for example Minutes=*/5 means every 5 minutes.

For a full explanation of the supported syntax see here

Output

An output message will be sent each scheduled time, [Target Property] will be set to the [Value].

Name Type Description
[Target Property] boolean the configured [value]

Example

#Settings

Target Property: data
value: false
Minute: 0
Hour: 12
Day of month: *
Month: *
Day of Week: 7

the following will be sent at 12:00 every sunday

# Output

{
  "data": false
}