Skip to content

Schedule

Starts this automation from a timezone-aware recurring schedule.

@lainstack/time/cron-trigger · Triggers

Key @lainstack/time/cron-trigger (“Schedule”). Starts a run on a recurring schedule. Choose it for work with no incoming event. Use @lainstack/api/invoke-trigger when another system should decide when to start.

References use the type key @lainstack/time/cron-trigger as the source blockId, never the block instance id.

Payload leaves (system only):

  • payload.system.scheduledAt, payload.system.cronExpression, payload.system.timezone, payload.system.scheduleId.

There is no business data. Fetch it in a later block, for example @lainstack/http/request.

Schedule:

  • Mode preset: hourly, daily, weekly or monthly. The default is daily at 09:00 UTC.
  • Mode advanced: a five-field cron expression. A six-field expression is rejected.
  • timezone is an IANA name, default UTC. A local time that does not exist (a clock change) is skipped.
  • overlapPolicy SKIP (default) skips a tick while the previous run is still going. BUFFER_ONE keeps one tick waiting.

A test run takes trigger data from a pinned sample (testing).

Setting Key Type Details
Schedule (required) schedule Record Choose a bounded preset or open Advanced for a five-field cron expression.
Output Path Type
Scheduled At payload.system.scheduledAt Text
Cron Expression payload.system.cronExpression Text
Timezone payload.system.timezone Text
Schedule ID payload.system.scheduleId Text