Skip to main content

Use case

Trigger a workflow on a recurring cadence without polling or external cron infrastructure. Use these endpoints to create, list, inspect, update, and delete schedules bound to a workflow.

API Reference

See the full request/response schema and parameters in the API Reference.

Pricing

Scheduled runs are billed the same as manual runs. See Credits & Pricing Guide for credit costs.

Errors

For error responses (400, 401, 403, 422, etc.), see Handling Errors.

Schedule definition

A schedule binds a workflow_id to a cron_expression and timezone:
  • workflow_id — the workflow to run. The workflow must already exist.
  • name — required, up to 120 characters.
  • cron_expression — standard 5-field cron (minute hour day month weekday).
  • timezone — IANA timezone, e.g. America/Los_Angeles. Defaults to UTC.
  • description — optional free-form text.
  • is_active — defaults to true. Set to false to save a schedule without activating it.
Schedules belong to their team. Removing their creator from the team or organization leaves them running unless an administrator selects the pause option. Key-bound schedules pause when their API key is revoked or expires. Archiving the team also pauses its schedules. An automatic pause sets disabled_reason on the response.
API keys remain valid after their creator leaves unless explicitly revoked. Anyone who still holds a key can continue using it. Selecting key revocation during member removal also pauses schedules bound to those keys.

Create schedule

Create a new schedule for a workflow.
Required body fields: workflow_id, name, and cron_expression.

Example request

Example response


List schedules

Retrieve all schedules for your organization.
Optional query parameter: workflow_id — filter to schedules for a single workflow.

Get schedule

Retrieve a single schedule by ID.

Update schedule

Update a schedule’s name, cadence, timezone, description, or active state.
All body fields (name, cron_expression, timezone, description, is_active) are optional — only include what you want to change.
Reactivating a paused schedule rebinds its execution identity to the current user or API key and clears disabled_reason. The schedule remains owned by its team.

Example request


Delete schedule

Permanently delete a schedule.
Deleting a schedule does not affect the underlying workflow or its run history.

Example usage