IAutomationSchedule

IAutomationSchedule.cronpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR).

Example: 0 */30 9-17 ? * MON-FRI (every 30 minutes from 9:00 to 17:00 on workdays)

cron: string;

IAutomationSchedule.cronDescriptionpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Human-readable description of the cron expression.

cronDescription?: string;

IAutomationSchedule.firstRunpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Timestamp of the first scheduled action If not provided default to the next scheduled time. It should not include timezone information (use timezone property instead).

Example: 2024-02-29T10:00:00.000Z

firstRun?: string;

IAutomationSchedule.timezonepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Timezone in which the schedule is defined.

Example: Europe/Prague

timezone?: string;