schedules operations

Generated from the shared operation catalog. Use the JSON catalog for complete input schemas. Required dependency checks can be stricter than the resource permission listed below.

schedule_monitorCopy Anchor Link

Read safe schedule status and workspace scheduling pause state for readable targets. Pages contain up to 50 candidates; follow next even when schedules is empty. Cursor expires after one hour and is bound to your account, credential and project filter. No definitions, inputs, channels, raw errors or execution.

• HTTP: GET /api/schedules/monitor
• SDK: client.schedules.monitor(input)
• Access: workspace
• Effect annotation: Read-only

schedule_monitor_runsCopy Anchor Link

Read the most recent 25 safe schedule outcomes for an authorized target. Status and timing only; no raw error messages, workflow results, inputs or mutation authority.

• HTTP: GET /api/schedules/:id/monitor
• SDK: client.schedules.monitorRuns(input)
• Access: workspace
• Effect annotation: Read-only

schedule_listCopy Anchor Link

List authorized workflow and dashboard schedules, available targets, and notification destinations. Project filtering uses stored target ownership. No execution.

• HTTP: GET /api/schedules
• SDK: client.schedules.list(input)
• Access: workspace
• Effect annotation: Read-only

schedule_getCopy Anchor Link

Read one authorized schedule and its last outcome.

• HTTP: GET /api/schedules/:id
• SDK: client.schedules.get(input)
• Access: workspace
• Effect annotation: Read-only

schedule_createCopy Anchor Link

Configure a published workflow trigger with explicit inputs and a pinned revision, or a dashboard delivery. Optional condition references a saved query and output: run when its result becomes nonempty (enter), when a previously nonempty result becomes empty (exit), or on each nonempty check (while). An initially empty result does not fire exit. Query filters own thresholds; its definition is snapshotted when saved. Recurrence is the check cadence. Requires target Write and execution permissions, including the condition query and sources. Saving never executes now. Enabled triggers authorize future runs; every check revalidates the creator and credential.

• HTTP: POST /api/schedules
• SDK: client.schedules.create(input)
• Access: workspace
• Effect annotation: May change state or run effects

See the JSON schema for this input contract.

schedule_updateCopy Anchor Link

Edit a schedule or pause it with enabled:false. Editing requires target Write. Resuming revalidates all inputs, permissions and destinations. Never executes immediately.

• HTTP: PATCH /api/schedules/:id
• SDK: client.schedules.update(input)
• Access: workspace
• Effect annotation: May change state or run effects

See the JSON schema for this input contract.

schedule_removeCopy Anchor Link

Remove an idle schedule and its scheduling history. The workflow or dashboard is retained.

• HTTP: DELETE /api/schedules/:id
• SDK: client.schedules.remove(input)
• Access: workspace
• Effect annotation: May change state or run effects; destructive operation

schedule_runCopy Anchor Link

Explicitly queue one run now. Runs as the current user and credential, using the saved definition. Can call APIs, send notifications, or change records according to the published workflow. Does not change the next automatic run time.

• HTTP: POST /api/schedules/:id/run
• SDK: client.schedules.run(input)
• Access: workspace
• Effect annotation: May change state or run effects

schedule_runsCopy Anchor Link

Read recent schedule outcomes and linked workflow run IDs. Does not return input values or database results.

• HTTP: GET /api/schedules/:id/runs
• SDK: client.schedules.runs(input)
• Access: workspace
• Effect annotation: Read-only