Schedules
Use these endpoints to list, create, update and delete the schedules that launch your Workflows. All of them need an API key. Creating, updating and deleting also need permission to edit schedules.
Schedule types
- One-time (
"type": "direct"): runs once atparams.directDateTime, a local date and time in the schedule'stimezoneLocation, such as"2099-10-07T09:30:00". - Repeatable (
"type": "repeatable"): runs on theparams.periodyou choose.
period |
Fields | Runs |
|---|---|---|
hourly |
minutes |
Every hour, at that minute |
daily |
hours, minutes |
Every day, at that time |
weekly |
dayOfWeek, hours, minutes |
Every week, on that day (0 = Sunday to 6 = Saturday) |
monthly |
dayNumber, hours, minutes |
Every month, on that day ("1" to "31", or "last") |
custom |
hours, minutes, seconds |
Every time that interval passes, counted from when the schedule was created |
Restrictions
Hourly, daily and custom schedules can skip days with params.restriction.excludeDays. Hourly and custom schedules can also run only within a time window with rangeStart and rangeEnd. Each restriction has isEnabled and value:
"restriction": {
"excludeDays": { "isEnabled": true, "value": [0, 6] },
"rangeStart": { "isEnabled": true, "value": { "hours": 9, "minutes": 0 } },
"rangeEnd": { "isEnabled": true, "value": { "hours": 17, "minutes": 0 } }
}
Choosing a Bot Runner
Set botRunner to make a specific Bot Runner run the schedule. It must be assigned to the Workflow. busyPolicy decides what happens when it's busy (queue or cancel), and offlinePolicy when it's offline (fallback to another assigned Bot Runner, or cancel). Set botRunner to null to use the Workflow's usual Bot Runner selection.
Updated