Skip to main content
A schedule runs one workflow on a cron expression. Each scheduled run is a Job, the same as a run you start yourself.

Create a schedule

Set WORKFLOW_ID to a workflow_id from List workflows. cURL also requires jq.
The response is the schedule, with up to three upcoming next_run_times.
HTTP 201

Parameters

A scheduled run of a workflow that starts with a webhook block processes that block’s saved sample input every time, and each run is billed. Without a saved sample input, every scheduled run fails. Send new rows with Run a workflow instead.

Overlapping and missed runs

  • Every scheduled time starts a run, even when the previous run is still going, so runs can overlap. Keep the interval longer than a typical run.
  • A run that cannot start at its scheduled time starts late if it can start within 1 hour. Otherwise it is skipped.
  • There is no minimum interval. * * * * * starts a run every minute, and each run is billed.
Each run uses the workflow’s saved definition at the time it starts, so edits apply from the next run. Find a schedule’s runs with GET /v1/jobs?workflow_id={workflow_id}. New runs appear after a short delay.

List schedules

GET /v1/schedules returns your team’s schedules as items with a next_cursor. Pass workflow_id to list one workflow’s schedules. Each schedule’s nullable owner_user_id is its current user owner; it is null when an API key owns it.
cURL

Get a schedule

cURL

Update a schedule

Send only the fields to change: name, cron_expression, timezone, description or is_active. This request pauses the schedule.
The response is the updated schedule. A paused schedule has is_active set to false and an empty next_run_times. Setting is_active to true resumes the schedule, makes the caller its owner and clears disabled_reason. owner_user_id reports this current owner, not necessarily the original creator; resuming as a person changes it to that user. A schedule pauses automatically, with disabled_reason set, when the API key it runs as is revoked or expires, when its team is archived, or when its creator is removed and an admin chooses to pause their schedules.

Delete a schedule

HTTP 200
Deleting a schedule does not affect the workflow or its run history.

Errors

For error responses, see Handling Errors.

Pricing

Scheduled runs are billed the same as runs you start yourself. See Credit Costs for more information.
Integrations built on the original /schedules routes keep working. See Workflow Schedules (Legacy).