Schedules

Operations of the Workflow Engine API. Paths are relative to your deployment's API host.

GET /api/workflow-engine-api/schedules

List schedules for the caller org

Authentication: bearer token (Authorization: Bearer <token>)

GET /api/workflow-engine-api/schedules/{id}

Get a schedule by id

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/workflow-engine-api/schedules/{id}/delegation

Authorize the schedule's firings under your organization's authority.

A schedule whose workflow hands organization authority to another workload, or reads a wallet, fires with no member present — so a member records an organization delegation from their own context, lending exactly the capabilities in delegation.capabilities. Held by the engine, renewed before it expires, revoked when the schedule goes away. The identity boundary decides who may authorize (an organization administrator unless the realm's policy admits others). Replaces any delegation the schedule held.

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/workflow-engine-api/schedules/{id}/pause

Pause a schedule (stops future fires until resumed).

Pauses the runtime schedule + stamps state=paused on the engine row. Schedules are DERIVED from workflow YAMLs by the reconciler — users do not create them directly; they author a workflow with on.schedule and the reconciler upserts a schedule row. Pause is the operator-facing control when the scheduled workflow should be temporarily halted without editing the YAML.

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/workflow-engine-api/schedules/{id}/resume

Resume a paused schedule.

Unpauses the runtime schedule + stamps state=active on the engine row.

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/workflow-engine-api/schedules/{id}/trigger

Fire the schedule immediately (one-off).

Calls trigger() on the backing runtime schedule so a scheduledDispatchWorkflow fires right now, bypassing the cron cadence. Respects the schedule's overlap policy — a fire that races with an already-running dispatch is skipped per runtime defaults.

Authentication: bearer token (Authorization: Bearer <token>)