Schedule

View as Markdown

When a scheduled alert or export runs.

IsOneOff: true runs once at RunAt (an ISO date-time). IsOneOff: false repeats on CronExpression, a 5-field cron (minute, hour, day of month, month, day of week). Weekdays in that cron are 0–6 with Sunday as 0; 1-5 is Monday to Friday.

TypeScript
export interface

Properties

PropertyTypeDescription
CronExpressionstringStandard 5-field cron (minute hour day-of-month month day-of-week); e.g. weekdays at 09:30 → 30 9 * * 1-5
IsOneOffbooleantrue runs once, at RunAt. false repeats on CronExpression.
RunAtstringISO datetime for a one-off run (local time); set when IsOneOff is true

Property Details

CronExpression

Standard 5-field cron (minute hour day-of-month month day-of-week); e.g. weekdays at 09:30 → 30 9 * * 1-5

TypeScript
CronExpression?: string;
Property Value

string

IsOneOff

true runs once, at RunAt. false repeats on CronExpression.

TypeScript
IsOneOff: boolean;
Property Value

boolean

RunAt

ISO datetime for a one-off run (local time); set when IsOneOff is true

TypeScript
RunAt?: string;
Property Value

string