Skip to main content
Run a tool on a schedule through the backend. The runtime runs a registered tool periodically. A schedule names the tool, its arguments, and a cadence; a worker backend fires it on time. Scheduled runs execute on the backend, so a backend plugin must be configured for schedules to run.

​
Configure a backend

A schedule runs on the worker backend, not in the request path. Register a backend plugin under backend_module in the manifest and start its worker runtime:
manifest.yml
See Backends for where tools run, and Author a backend to build an engine.

​
Add a schedule

Name the tool to run and its cadence. Pass tool arguments with --tool-kw key=value (or --tool-kwargs as JSON), and the cadence with --schedule-kw (or --schedule-kwargs).

​
Inspect and remove

1

List schedules

2

Check the server clock

Cron cadences resolve against the server’s clock — read it to reason about when a job fires.
3

Delete a schedule

A schedule and a webhook binding are the two ways a tool fires without a client call. To fire a tool on an inbound event instead, see Fire a tool from a webhook.

​
See also