ScheduleDefinition
May 22, 2026 ยท View on GitHub
Specification of the times scheduled actions may occur.
The times are the union of :py:attr:calendars, :py:attr:intervals, and
:py:attr:cron_expressions excluding anything in :py:attr:skip.
Used for input where schedule_id is optional (can be provided or auto-generated).
Fields
| Field | Type | Required | Description |
|---|---|---|---|
input | Any | :heavy_check_mark: | Input to provide to the workflow when starting it. |
calendars | List[models.ScheduleCalendar] | :heavy_minus_sign: | Calendar-based specification of times. |
intervals | List[models.ScheduleInterval] | :heavy_minus_sign: | Interval-based specification of times. |
cron_expressions | List[str] | :heavy_minus_sign: | Cron-based specification of times. |
skip | List[models.ScheduleCalendar] | :heavy_minus_sign: | Set of calendar times to skip. |
start_at | date | :heavy_minus_sign: | Time after which the first action may be run. |
end_at | date | :heavy_minus_sign: | Time after which no more actions will be run. |
jitter | OptionalNullable[str] | :heavy_minus_sign: | Jitter to apply each action. An action's scheduled time will be incremented by a random value between 0 and this value if present (but not past the next schedule). |
time_zone_name | OptionalNullable[str] | :heavy_minus_sign: | IANA time zone name, for example US/Central. |
policy | Optional[models.SchedulePolicy] | :heavy_minus_sign: | N/A |
max_executions | OptionalNullable[int] | :heavy_minus_sign: | Maximum number of times this schedule will trigger a workflow execution. Once this limit is reached, no further executions are triggered automatically. null means unlimited. |
schedule_id | OptionalNullable[str] | :heavy_minus_sign: | Unique identifier for the schedule. |