Quick start
How cron works
- Cron runs inside the Gateway process, not inside the model. The Gateway must be running for schedules to fire.
- Job definitions, runtime state, and run history persist in OpenClaw’s shared SQLite state database, so restarts do not lose schedules.
- Every cron execution creates a background task record.
- One-shot jobs (
--at) auto-delete after success by default; pass--keep-after-runto keep them. - Per-run wall-clock budget:
--timeout-secondswhen set. Otherwise, isolated/detached agent-turn jobs are bounded by cron’s own 60-minute watchdog before the underlying agent-turn timeout (agents.defaults.timeoutSeconds, default 48 hours) would ever apply; command jobs default to 10 minutes. - On Gateway startup, overdue isolated agent-turn jobs are rescheduled instead of replayed immediately, keeping model/tool bootstrap work out of the channel-connect window.
- If you drive
openclaw agentfrom system cron or another external scheduler, wrap it with a hard-kill escalation even though the CLI already handlesSIGTERM/SIGINT. Gateway-backed runs ask the Gateway to abort accepted runs; local and embedded fallback runs get the same abort signal. For GNUtimeout, prefertimeout -k 60 600 openclaw agent ...over plaintimeout 600 ...— the-kvalue is the backstop if the process cannot drain in time. For systemd units, use aSIGTERMstop signal with a grace window (TimeoutStopSec) before the final kill. Reusing a--run-idwhile the original Gateway run is still active reports the duplicate as in-flight instead of starting a second run.
Isolated run hardening
Isolated run hardening
- Isolated runs best-effort close tracked browser tabs/processes for their
cron:<jobId>session on completion, and dispose any bundled MCP runtime instances created for the job through the same shared teardown path used by main-session and custom-session runs. Cleanup failures are ignored so the cron result still wins. - Isolated runs with the narrow cron self-cleanup grant can read scheduler status, a self-filtered list containing only their own job, and that job’s run history, and may remove only their own job.
- Isolated runs guard against stale acknowledgement replies: if the first result is only an interim status update (
on it,pulling everything together, and similar hints) and no descendant subagent is still responsible for the final answer, OpenClaw re-prompts once for the actual result before delivery. - Structured execution-denial metadata (including node-host
UNAVAILABLEwrappers whose nested error starts withSYSTEM_RUN_DENIEDorINVALID_REQUEST) is recognized so a blocked command is not reported as a green run, while ordinary assistant prose is not mistaken for a denial. - Run-level agent failures count as job errors even with no reply payload, so model/provider failures increment error counters and trigger failure notifications instead of clearing the job as successful.
- When a job hits
timeoutSeconds, cron aborts the run and gives it a short cleanup window. If it does not drain, Gateway-owned cleanup force-clears that run’s session ownership before cron records the timeout, so queued chat work is not stuck behind a stale processing session. - Setup/startup stalls get a phase-specific timeout (for example
cron: isolated agent setup timed out before runner startorcron: isolated agent run stalled before execution start (last phase: context-engine)). These watchdogs cover embedded and CLI-backed providers even before their external CLI process starts, and are capped independently of longtimeoutSecondsvalues so cold-start/auth/context failures surface quickly.
Task reconciliation
Task reconciliation
Cron task reconciliation is runtime-owned first, durable-history-backed second: an active cron task stays live while the cron runtime still tracks that job as running, even if an old child session row still exists. Once the runtime stops owning the job and a 5-minute grace window expires, maintenance checks persisted run logs and job state for the matching
cron:<jobId>:<startedAt> run. A terminal result there finalizes the task ledger; otherwise Gateway-owned maintenance can mark the task lost. Offline CLI audit can recover from durable history, but its own empty in-process active-job set is not proof a Gateway-owned run is gone.Schedule types
| Kind | CLI flag | Description |
|---|---|---|
at | --at | One-shot timestamp (ISO 8601 or relative like 20m) |
every | --every | Fixed interval (10m, 1h, 1d) |
cron | --cron | 5-field or 6-field cron expression with optional --tz |
on-exit | --on-exit | Fire once when a watched command exits (event trigger; survives turn teardown; optional --on-exit-cwd) |
--tz America/New_York to interpret an offset-less --at datetime, or to evaluate a cron expression, in that IANA timezone. Cron expressions without --tz use the Gateway host timezone. --tz is not valid with --every or --on-exit.
Recurring top-of-hour expressions (minute 0 with a wildcard hour field) are automatically staggered by up to 5 minutes to reduce load spikes. Use --exact to force precise timing, or --stagger 30s for an explicit window (cron schedules only).
Day-of-month and day-of-week use OR logic
Cron expressions are parsed by croner. When both the day-of-month and day-of-week fields are non-wildcard, croner matches when either field matches, not both. This is standard Vixie cron behavior.+ day-of-week modifier (0 9 15 * +1), or schedule on one field and guard the other in your job’s prompt or command.
Payloads
Every job carries exactly one payload kind, chosen by flag:| Payload | Flag | Runs |
|---|---|---|
| System event | --system-event <text> | Enqueued into the main session, no model call by itself |
| Agent message | --message <text> | A model-backed agent turn |
| Command | --command <shell> or --command-argv <json> | A shell/process on the Gateway host, no model call |
Agent-turn options
Prompt text (required for isolated/current/custom-session jobs).
Model override; must resolve to an allowed model or the run fails with a validation error.
Per-job fallback model list, for example
--fallbacks openai/gpt-5.5,openrouter/meta-llama/llama-3.3-70b-instruct:free. Pass --fallbacks "" for a strict run with no fallbacks.On
cron edit, removes the per-job fallback override so the job follows configured fallback precedence. Cannot combine with --fallbacks.On
cron edit, removes the per-job model override so the job follows normal cron model precedence (stored cron-session override, else agent/default model). Cannot combine with --model.Thinking level override (
off|minimal|low|medium|high|xhigh|adaptive|max).On
cron edit, removes the per-job thinking override. Cannot combine with --thinking.Skip workspace bootstrap file injection.
Restrict which tools the job can use, for example
--tools exec,read.--model sets the job’s primary model; it does not replace a session /model override, so configured fallback chains still apply on top of it. An unresolved or disallowed model fails the run with an explicit validation error rather than silently falling back to the default. If a job has --model but no explicit or configured fallback list, OpenClaw passes an empty fallback override instead of silently appending the agent primary as a hidden retry target.
Model-selection precedence for isolated jobs, highest first:
- Per-job payload
model(explicit config; a disallowed model fails the run) - Gmail hook model override (only when the run came from Gmail and that override is allowed)
- User-selected stored cron-session model override
- Agent/default model selection
params.fastMode, isolated cron uses it by default; a stored session fastMode override (then an agent fastModeDefault) still wins over model config either direction. Auto mode uses the model’s params.fastAutoOnSeconds cutoff, defaulting to 60 seconds.
If a run hits a live model-switch handoff, cron retries with the switched provider/model and persists that selection (and any new auth profile) for the active run. Retries are bounded: after the initial attempt plus 2 switch retries, cron aborts instead of looping.
Before an isolated run starts, OpenClaw checks reachable local endpoints for configured api: "ollama" and api: "openai-completions" providers whose baseUrl is loopback, private-network, or .local. This preflight walks the job’s configured fallback chain and only marks the run skipped once every candidate is unreachable; --fallbacks "" keeps that walk strict to just the primary model. A down endpoint records the run as skipped with a clear error instead of starting a model call. The result is cached for 5 minutes per endpoint (not per job or model), so many due jobs sharing a dead local Ollama/vLLM/SGLang/LM Studio server cost one probe instead of a request storm. Skipped preflight runs do not increment execution-error backoff; set failureAlert.includeSkipped to opt into repeated skip alerts.
Command payloads
Command payloads run deterministic scripts inside the Gateway scheduler without starting a model-backed turn. They execute on the Gateway host, capture stdout/stderr, record the run in cron history, and reuse the sameannounce, webhook, and none delivery modes as agent-turn jobs.
Command cron is an operator-admin Gateway automation surface, not an agent
tools.exec call. Creating, updating, removing, or manually running cron jobs requires operator.admin; scheduled command runs later execute inside the Gateway process as that admin-authored automation. Agent exec policy (tools.exec.mode, approval prompts, per-agent tool allowlists) governs model-visible exec tools, not command cron payloads.--command <shell> stores argv: ["sh", "-lc", <shell>]. Use --command-argv '["node","scripts/report.mjs"]' for exact argv execution without shell parsing. Optional --command-env KEY=VALUE (repeatable), --command-input, --timeout-seconds (default 10 minutes), --no-output-timeout-seconds, and --output-max-bytes control the process environment, stdin, and output bounds.
Delivered text is derived from process output: non-empty stdout wins; if stdout is empty and stderr is non-empty, stderr is delivered; if both are present, cron sends a small stdout: / stderr: block. Exit code 0 records the run ok; non-zero exit, signal, timeout, or no-output timeout records error and can trigger failure alerts. A command that prints only NO_REPLY uses the normal cron silent-token suppression and posts nothing back to chat.
Execution styles
| Style | --session value | Runs in | Best for |
|---|---|---|---|
| Main session | main | Dedicated cron wake lane | Reminders, system events |
| Isolated | isolated | Dedicated cron:<jobId> | Reports, background chores |
| Current session | current | Bound at creation time | Context-aware recurring work |
| Custom session | session:custom-id | Persistent named session | Workflows that build on history |
Main session vs isolated vs custom
Main session vs isolated vs custom
Main session jobs enqueue a system event into a cron-owned run lane and optionally wake the heartbeat (
--wake now or --wake next-heartbeat). They can use the target main session’s last delivery context for replies, but do not append routine cron turns to the human chat lane and do not extend daily/idle reset freshness for the target session. Isolated jobs run a dedicated agent turn with a fresh session. Custom sessions (session:xxx) persist context across runs, enabling workflows like daily standups that build on previous summaries.Main-session cron events are self-contained system-event reminders. They do not automatically include the default heartbeat prompt’s “Read HEARTBEAT.md” instruction; say that explicitly in the cron event text if a reminder should consult HEARTBEAT.md.What 'fresh session' means for isolated jobs
What 'fresh session' means for isolated jobs
A new transcript/session id per run. OpenClaw carries safe preferences (thinking/fast/verbose settings, labels, explicit user-selected model/auth overrides), but does not inherit ambient conversation context from an older cron row: channel/group routing, send or queue policy, elevation, origin, or ACP runtime binding. Use
current or session:<id> when a recurring job should deliberately build on the same conversation context.Subagent and Discord delivery
Subagent and Discord delivery
When isolated cron runs orchestrate subagents, delivery prefers the final descendant output over stale parent interim text. If descendants are still running, OpenClaw suppresses that partial parent update instead of announcing it.For text-only Discord announce targets, OpenClaw sends the canonical final assistant text once instead of replaying both streamed/intermediate text and the final answer. Media and structured Discord payloads are still delivered separately so attachments and components are not dropped.
Delivery and output
| Mode | What happens |
|---|---|
announce | Fallback-deliver final text to the target if the agent did not send |
webhook | POST finished event payload to a URL |
none | No runner fallback delivery |
--announce --channel telegram --to "-1001234567890" for channel delivery. For Telegram forum topics, use -1001234567890:topic:123; OpenClaw also accepts the Telegram-owned -1001234567890:123 shorthand. Direct RPC/config callers may pass delivery.threadId as a string or number. Slack/Discord/Mattermost targets use explicit prefixes (channel:<id>, user:<id>). Matrix room IDs are case-sensitive; use the exact room ID or room:!room:server form from Matrix.
When announce delivery uses channel: "last" or omits channel, a provider-prefixed target such as telegram:123 can select the channel before cron falls back to session history or a single configured channel. Only prefixes advertised by the loaded plugin are provider selectors. If delivery.channel is explicit, the target prefix must name the same provider; channel: "whatsapp" with to: "telegram:123" is rejected instead of letting WhatsApp interpret the Telegram ID as a phone number. Target-kind and service prefixes (channel:<id>, user:<id>, imessage:<handle>, sms:<number>) stay channel-owned target syntax, not provider selectors.
For isolated jobs, chat delivery is shared: if a chat route is available, the agent can use the message tool even with --no-deliver. If the agent sends to the configured/current target, OpenClaw skips the fallback announce. Otherwise announce, webhook, and none only control what the runner does with the final reply after the agent turn.
When an agent creates an isolated reminder from an active chat, OpenClaw stores the preserved live delivery target for the fallback announce route. Internal session keys may be lowercase; provider delivery targets are not reconstructed from those keys when current chat context is available.
Implicit announce delivery uses configured channel allowlists to validate and reroute stale targets. DM pairing-store approvals are not fallback automation recipients; set delivery.to or configure the channel allowFrom entry when a scheduled job should proactively send to a DM.
Failure notifications
Failure notifications follow a separate destination path:cron.failureDestinationsets a global default for failure notifications.job.delivery.failureDestinationoverrides that per job.- If neither is set and the job already delivers via
announce, failure notifications fall back to that primary announce target. delivery.failureDestinationis only supported onsessionTarget="isolated"jobs unless the primary delivery mode iswebhook.failureAlert.includeSkipped: trueopts a job or global cron alert policy into repeated skipped-run alerts. Skipped runs keep a separate consecutive-skip counter, so they do not affect execution-error backoff.openclaw cron editexposes per-job alert tuning:--failure-alert/--no-failure-alert,--failure-alert-after <n>,--failure-alert-channel,--failure-alert-to,--failure-alert-cooldown,--failure-alert-include-skipped/--failure-alert-exclude-skipped,--failure-alert-mode, and--failure-alert-account-id.
Output language
Cron jobs do not infer a reply language from channel, locale, or previous messages. Put the language rule in the scheduled message or template:{{language}} are filled before the job runs. If the output mixes languages, make the rule explicit, for example: “Use Chinese for narrative text and keep technical terms in English.”
CLI examples
- One-shot reminder
- Recurring isolated job
- Model and thinking override
- Webhook output
- Command output
Managing jobs
openclaw cron run <jobId> returns after enqueueing the manual run. Use --wait for shutdown hooks, maintenance scripts, or other automation that must block until the queued run finishes; it polls the returned runId (default timeout 10m, poll interval 2s) and exits 0 for status ok, non-zero for error, skipped, or a wait timeout.
The agent cron tool returns compact job summaries (id, name, enabled, nextRunAtMs, scheduleKind, lastRunStatus) from cron(action: "list"); use cron(action: "get", jobId: "...") for one full job definition. Direct Gateway callers can pass compact: true to cron.list; omitting it preserves the full response with delivery previews.
openclaw cron create is an alias for openclaw cron add. New jobs can use a positional schedule ("0 9 * * 1", "every 1h", "20m", or an ISO timestamp) followed by a positional agent prompt. Use --webhook <url> on cron add|create or cron edit to POST the finished run payload to an HTTP endpoint; webhook delivery cannot combine with chat delivery flags (--announce, --channel, --to, --thread-id, --account). On cron edit, --clear-channel, --clear-to, --clear-thread-id, and --clear-account unset those routing fields individually (each rejected alongside its matching set flag) — distinct from --no-deliver, which only disables runner fallback delivery.
Model override note:
openclaw cron add|edit --model ...changes the job’s selected model.- If the model is allowed, that exact provider/model reaches the isolated agent run.
- If it is not allowed or cannot be resolved, cron fails the run with an explicit validation error.
- API
cron.updatepayload patches can setmodel: nullto clear a stored job model override. openclaw cron edit <job-id> --clear-modelclears that override from the CLI (same effect as themodel: nullpatch) and cannot combine with--model.- Configured fallback chains still apply because cron
--modelis a job primary, not a session/modeloverride. openclaw cron add|edit --fallbacks ...sets payloadfallbacks, replacing configured fallbacks for that job;--fallbacks ""disables fallback and makes the run strict.openclaw cron edit <job-id> --clear-fallbacksclears the per-job override.- A plain
--modelwith no explicit or configured fallback list does not fall through to the agent primary as a silent extra retry target.
Webhooks
Gateway can expose HTTP webhook endpoints for external triggers. Enable in config:Authentication
Every request must include the hook token via header:Authorization: Bearer <token>(recommended)x-openclaw-token: <token>
POST /hooks/wake
POST /hooks/wake
POST /hooks/agent
POST /hooks/agent
Run an isolated agent turn:Fields:
message (required), name, agentId, sessionKey (requires hooks.allowRequestSessionKey=true), idempotencyKey, wakeMode, deliver, channel, to, model, thinking, timeoutSeconds.Mapped hooks (POST /hooks/<name>)
Mapped hooks (POST /hooks/<name>)
Custom hook names resolve via
hooks.mappings in config. Mappings can transform arbitrary payloads into wake or agent actions with templates or code transforms.Gmail PubSub integration
Wire Gmail inbox triggers to OpenClaw via Google PubSub.Prerequisites:
gcloud CLI, gog (gogcli), OpenClaw hooks enabled, Tailscale for the public HTTPS endpoint.Wizard setup (recommended)
hooks.gmail config, enables the Gmail preset, and defaults to Tailscale Funnel for the push endpoint (--tailscale funnel|serve|off).
Gateway auto-start
Whenhooks.enabled=true and hooks.gmail.account is set, the Gateway starts gog gmail watch serve on boot and auto-renews the watch. Set OPENCLAW_SKIP_GMAIL_WATCHER=1 to opt out.
Manual one-time setup
Gmail model override
Configuration
retry values above are the defaults: up to 3 retries with 30s/60s/5m backoff, retrying all five transient categories. webhookToken is sent as Authorization: Bearer <token> on cron webhook POSTs.
maxConcurrentRuns limits both scheduled cron dispatch and isolated agent-turn execution, and defaults to 8. Isolated cron agent turns use the queue’s dedicated cron-nested execution lane internally, so raising this value lets independent cron LLM runs progress in parallel instead of only starting their outer cron wrappers. The shared non-cron nested lane is not widened by this setting.
cron.store is a logical store key and doctor migration path, not a live JSON file to hand-edit. Job data lives in SQLite; use the CLI or Gateway API for changes.
Disable cron: cron.enabled: false or OPENCLAW_SKIP_CRON=1.
Retry behavior
Retry behavior
One-shot retry: transient errors (rate limit, overload, network, timeout, server error) retry up to
retry.maxAttempts times (default 3) using retry.backoffMs (default 30s, 60s, 5m). Permanent errors disable the job immediately.Recurring retry: consecutive execution errors back off on an extended schedule (30s, 60s, 5m, 15m, 60m). Backoff resets after the next successful run.Maintenance
Maintenance
cron.sessionRetention (default 24h, false disables) prunes isolated run-session entries. cron.runLog.keepLines limits retained SQLite run-history rows per job; maxBytes is retained for config compatibility with older file-backed run logs.Legacy store migration
Legacy store migration
On upgrade, run
openclaw doctor --fix to import legacy ~/.openclaw/cron/jobs.json, jobs-state.json, and runs/*.jsonl files into SQLite and rename them with a .migrated suffix. Malformed job rows are skipped from runtime and copied to jobs-quarantine.json for later repair or review.Troubleshooting
Command ladder
Cron not firing
Cron not firing
- Check
cron.enabledand theOPENCLAW_SKIP_CRONenv var. - Confirm the Gateway is running continuously.
- For
cronschedules, verify timezone (--tz) vs the host timezone. reason: not-duein run output means the manual run was checked withopenclaw cron run <jobId> --dueand the job was not due yet.
Cron fired but no delivery
Cron fired but no delivery
- Delivery mode
nonemeans no runner fallback send is expected. The agent can still send directly with themessagetool when a chat route is available. - Delivery target missing/invalid (
channel/to) means outbound was skipped. - For Matrix, copied or legacy jobs with lowercased
delivery.toroom IDs can fail because Matrix room IDs are case-sensitive. Edit the job to the exact!room:serverorroom:!room:servervalue from Matrix. - Channel auth errors (
unauthorized,Forbidden) mean delivery was blocked by credentials. - If the isolated run returns only the silent token (
NO_REPLY/no_reply), OpenClaw suppresses direct outbound delivery and the fallback queued-summary path, so nothing is posted back to chat. - If the agent should message the user itself, check that the job has a usable route (
channel: "last"with a previous chat, or an explicit channel/target).
Cron or heartbeat appears to prevent /new-style rollover
Cron or heartbeat appears to prevent /new-style rollover
- Daily and idle reset freshness is not based on
updatedAt; see Session management. - Cron wakeups, heartbeat runs, exec notifications, and gateway bookkeeping may update the session row for routing/status, but they do not extend
sessionStartedAtorlastInteractionAt. - For legacy rows created before those fields existed, OpenClaw can recover
sessionStartedAtfrom the transcript JSONL session header when the file is still available. Legacy idle rows withoutlastInteractionAtuse that recovered start time as their idle baseline.
Timezone gotchas
Timezone gotchas
- Cron without
--tzuses the gateway host timezone. atschedules without timezone are treated as UTC.- Heartbeat
activeHoursuses configured timezone resolution.
Related
- Automation — all automation mechanisms at a glance
- Background Tasks — task ledger for cron executions
- Heartbeat — periodic main-session turns
- Timezone — timezone configuration