Skip to main content
Scheduled events run automations at regular times rather than in response to commerce activity. Use them for recurring tasks like daily reports, weekly cleanup, or periodic syncs. This page covers the schedule object itself. It goes under schedule_config in the automation definition, alongside "trigger_type": "SCHEDULE".

Schedule types

Cron

Run at specific times using a cron expression:
Standard 5-field cron format: minute hour day-of-month month day-of-week.

Interval

Run at a fixed interval in seconds:
The minimum interval is 60 seconds.

Configuration

Validation

  • cron_expression is required when schedule_type is "cron"
  • interval_seconds is required when schedule_type is "interval"
  • Interval must be at least 60 seconds

Schedule info

Once a scheduled automation is created, you can query its next run times through the GraphQL API. The ScheduleInfo type returns its upcoming run times.