Heartbeat vs cron? See Automation for guidance on when to use each.
openclaw cron list --all as Heartbeat (agent-id)). Heartbeat config remains the desired-state input, while the persisted monitor schedule owns the actual tick and the runner’s later cooldown. The gateway writes config changes through at startup and on config reload; openclaw doctor --fix can materialize missing or stale monitor rows before the next gateway start. Edit agents.*.heartbeat, not the cron job.
Scheduled heartbeats require cron. When cron.enabled is false or OPENCLAW_SKIP_CRON=1, the gateway logs a startup warning and does not run scheduled heartbeats; manual and event-driven heartbeat wakes remain available. There is no separate heartbeat fallback timer.
Troubleshooting: Scheduled Tasks
Quick start (beginner)
1
Pick a cadence
Leave heartbeats enabled (default is
30m, or 1h when Anthropic OAuth/token auth is configured, including Claude CLI reuse) or set your own cadence.2
Add monitor scratch (optional)
Store a tiny checklist in the heartbeat monitor’s scratch with
openclaw cron scratch <jobId> --set "...".3
Decide where heartbeat messages should go
target: "none" is the default; set target: "last" to route to the last contact.4
Optional tuning
- Use lightweight bootstrap context if heartbeat runs only need the monitor scratch.
- Enable isolated sessions to avoid sending full conversation history each heartbeat.
- Restrict heartbeats to active hours (local time).
Defaults
- Interval:
30m. Applying Anthropic provider defaults bumps this to1hwhen the resolved auth mode is OAuth/token (including Claude CLI reuse), but only whileheartbeat.everyis unset. Setagents.defaults.heartbeat.everyor per-agentagents.entries.*.heartbeat.every; use0mto disable. - Prompt body (configurable via
agents.defaults.heartbeat.prompt):Follow the heartbeat monitor scratch context when provided. Recurring tasks are cron jobs; create or change their schedules with cron tools or the openclaw cron CLI, not heartbeat scratch. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK. - Timeout: unset heartbeat turns use
agents.defaults.timeoutSecondswhen set. Otherwise, they use the heartbeat cadence capped at 600 seconds. Setagents.defaults.heartbeat.timeoutSecondsor per-agentagents.entries.*.heartbeat.timeoutSecondsfor longer heartbeat work. - The heartbeat prompt is sent verbatim as the user message. The system prompt automatically includes a “Heartbeats” section when cadence is enabled for the default agent; that guidance has no separate heartbeat toggle.
- When heartbeats are disabled with
0m, the monitor cron job stays but is disabled, and its scratch is retained for when you re-enable the cadence. - When cron itself is disabled, scheduled heartbeats do not run even if heartbeat cadence remains enabled.
- Active hours (
heartbeat.activeHours) are checked in the configured timezone. Outside the window, heartbeats are skipped until the next tick inside the window. - Scheduled heartbeats defer while the main queue or cron work is active or queued, while any reply or embedded run for the same agent is active, and while the resolved target session has active or queued work. Immediate and manual wakes bypass the broad same-agent active-run check, but still honor the main, cron, and target-session busy guards. Sibling agents do not pause each other.
What the heartbeat prompt is for
The default prompt is intentionally narrow: follow the heartbeat monitor scratch context when provided, keep recurring work in cron jobs, and replyHEARTBEAT_OK when nothing needs attention. It explicitly tells the agent
not to infer or repeat old tasks from prior chats, so a default install stays
quiet instead of rehashing stale conversation context.
Proactive heartbeat behavior is opt-in:
- Recurring checks: create scheduled jobs for inbox review, calendar sweeps, or queued follow-ups. Each job executes its configured payload on its own schedule; the default heartbeat does not infer recurring work from prior chats.
- Human check-in: create a scheduled job if you want an occasional lightweight “anything you need?” message, and constrain its schedule to avoid night-time pings in your configured local timezone (see Timezone).
agents.defaults.heartbeat.prompt (or agents.entries.*.heartbeat.prompt) to a custom body (sent verbatim).
Response contract
- If nothing needs attention, reply with
HEARTBEAT_OK. - Heartbeat runs may instead call
heartbeat_respondwithnotify: falsefor no visible update, ornotify: trueplusnotificationTextfor an alert. When present, the structured tool response takes precedence over the text fallback. - A meaningful
heartbeat_respondresult withnotify: falseremains silent but is remembered as bounded internal context for the next user turn in that session.no_changeacknowledgments and visible notifications are not stored this way. - During heartbeat runs, OpenClaw treats
HEARTBEAT_OKas an ack when it appears at the start or end of the reply. The token is stripped and the reply is dropped if the remaining content is at most 300 characters. This suppression budget is fixed, not configurable per heartbeat. - If
HEARTBEAT_OKappears in the middle of a reply, it is not treated specially. - For alerts, do not include
HEARTBEAT_OK; return only the alert text. - Delivery selects the last outbound-capable non-reasoning payload. Separate reasoning or thinking payloads remain internal; a reasoning-only result produces no alert.
- Tool error warnings remain enabled during heartbeat turns.
HEARTBEAT_OK at the start/end of a message is stripped and logged; a message that is only HEARTBEAT_OK is dropped.
Config
Scope and precedence
agents.defaults.heartbeatsets global heartbeat behavior.agents.entries.*.heartbeatmerges on top; if any agent has aheartbeatblock, only those agents run heartbeats.channels.defaults.heartbeatVisibilitysets visibility defaults for all channels.channels.<channel>.heartbeatVisibilityoverrides channel defaults.channels.<channel>.accounts.<id>.heartbeatVisibility(multi-account channels) overrides per-channel settings.
Per-agent heartbeats
If anyagents.entries.* entry includes a heartbeat block, only those agents run heartbeats. The per-agent block merges on top of agents.defaults.heartbeat (so you can set shared defaults once and override per agent).
Example: two agents, only the second agent runs heartbeats.
Active hours example
Restrict heartbeats to business hours in a specific timezone:24/7 setup
If you want heartbeats to run all day, use one of these patterns:- Omit
activeHoursentirely (no time-window restriction; this is the default behavior). - Set a full-day window:
activeHours: { start: "00:00", end: "24:00" }.
Multi-account example
UseaccountId to target a specific account on multi-account channels like Telegram:
Field notes
string
Heartbeat interval (duration string; default unit = minutes).
string
Optional model override for heartbeat runs (
provider/model).boolean
default:"false"
When true, heartbeat runs use lightweight bootstrap context and skip workspace bootstrap files. Monitor scratch is injected by the heartbeat runner either way.
boolean
default:"false"
When true, each heartbeat runs in a fresh session with no prior conversation history. Uses the same isolation pattern as cron
sessionTarget: "isolated". Dramatically reduces per-heartbeat token cost. Combine with lightContext: true for maximum savings. Delivery routing still uses the main session context.string
Optional session key for heartbeat runs.
main(default): agent main session.- Explicit session key (copy from
openclaw sessions --jsonor the sessions CLI). - Session key formats: see Sessions and Groups.
string
last: deliver to the last used external channel.- explicit channel: any configured channel or plugin id, for example
discord,matrix,telegram, orwhatsapp. none(default): run the heartbeat but do not deliver externally.
"allow" | "block"
default:"allow"
Controls direct/DM delivery behavior.
allow: allow direct/DM heartbeat delivery. block: suppress direct/DM delivery (reason=dm-blocked).string
Optional recipient override (channel-specific id, e.g. E.164 for WhatsApp or a Telegram chat id). For Telegram topics/threads, use
<chatId>:topic:<messageThreadId>.string
Optional account id for multi-account channels. When
target: "last", the account id applies to the resolved last channel if it supports accounts; otherwise it is ignored. If the account id does not match a configured account for the resolved channel, delivery is skipped.string
Overrides the default prompt body (not merged).
number
default:"global timeout or min(every, 600)"
Maximum seconds allowed for a heartbeat agent turn before it is aborted. Leave unset to use
agents.defaults.timeoutSeconds when set, otherwise the heartbeat cadence capped at 600 seconds.object
Restricts heartbeat runs to a time window. Object with
start (HH:MM, inclusive; use 00:00 for start-of-day), end (HH:MM exclusive; 24:00 allowed for end-of-day), and optional timezone.- Omitted or
"user": uses youragents.defaults.userTimezoneif set, otherwise falls back to the host system timezone. "local": always uses the host system timezone.- Any IANA identifier (e.g.
America/New_York): used directly; if invalid, falls back to the"user"behavior above. startandendmust not be equal for an active window; equal values are treated as zero-width (always outside the window).- Outside the active window, heartbeats are skipped until the next tick inside the window.
Heartbeat configuration is strict: only the fields listed above are accepted. Acknowledgment suppression, reasoning visibility, system-prompt guidance, busy deferral, and tool-error warning behavior are fixed runtime policies rather than heartbeat configuration fields.
Delivery behavior
Session and target routing
Session and target routing
- Heartbeats run in the agent’s main session by default (
agent:<id>:<mainKey>), orglobalwhensession.scope = "global". Setsessionto override to a specific channel session (Discord/WhatsApp/etc.). sessiononly affects the run context; delivery is controlled bytargetandto.- To deliver to a specific channel/recipient, set
target+to. Withtarget: "last", delivery uses the last external channel for that session. - Heartbeat deliveries allow direct/DM targets by default. Set
directPolicy: "block"to suppress direct-target sends while still running the heartbeat turn. - Scheduled heartbeats are skipped and retried later when the main queue or cron work is busy, any reply or embedded run for the same agent is active, or the resolved target session has active or queued work. Immediate and manual wakes bypass only the broad same-agent active-run precheck.
- If
targetresolves to no external destination, the run still happens but no outbound message is sent.
Visibility and skip behavior
Visibility and skip behavior
- If
showOk,showAlerts, anduseIndicatorare all disabled, the run is skipped up front asreason=alerts-disabled. - If only alert delivery is disabled, OpenClaw can still run the heartbeat, update due-task timestamps, restore the session idle timestamp, and suppress the outward alert payload.
- If the resolved heartbeat target supports typing, OpenClaw shows typing while the heartbeat run is active. This uses the same target the heartbeat would send chat output to, and it is disabled by
typingMode: "never".
Session lifecycle and audit
Session lifecycle and audit
- Heartbeat-only replies do not keep the session alive. Heartbeat metadata may update the session row, but idle expiry uses
lastInteractionAtfrom the last real user/channel message, and daily expiry usessessionStartedAt. - Control UI and WebChat history hide heartbeat prompts and OK-only acknowledgments. The underlying session transcript can still contain those turns for audit/replay.
- Detached background tasks can enqueue a system event and wake heartbeat when the main session should notice something quickly. That wake does not make the heartbeat run a background task.
Visibility controls
By default,HEARTBEAT_OK acknowledgments are suppressed while alert content is delivered. You can adjust this per channel or per account:
What each flag does
showOk: sends aHEARTBEAT_OKacknowledgment when the model returns an OK-only reply.showAlerts: sends the alert content when the model returns a non-OK reply.useIndicator: emits indicator events for UI status surfaces.
Per-channel vs per-account examples
Common patterns
Monitor scratch (optional)
Each heartbeat monitor cron job owns a private scratch document stored in the shared state database. Think of it as your “heartbeat checklist”: small, stable, and safe to consider every 30 minutes. When scratch exists, its content is appended to the heartbeat prompt. Manage it with the cron CLI (the job id comes fromopenclaw cron list --all):
--expected-revision <n> to fail instead of overwriting a concurrent edit. Scratch is capped at 256 KiB and never appears in cron list/cron runs output.
The agent can also update its own scratch: during a heartbeat turn, heartbeat_respond accepts an optional scratch string that fully replaces the monitor’s scratch for future heartbeats.
Migrating from HEARTBEAT.md or config-only cadence? Run
openclaw doctor --fix. Doctor first creates or updates the system-owned monitor rows from agents.*.heartbeat, then imports each agent’s workspace HEARTBEAT.md into the monitor’s scratch, converts any valid legacy tasks: entries into cron jobs, archives the original under the state directory (backups/heartbeat-migration/), and removes the file. Runtime heartbeat instructions come from database scratch only; the runtime never reads HEARTBEAT.md.# Heading, fence markers, or empty checklist stubs), OpenClaw skips the heartbeat run to save API calls. That skip is reported as reason=empty-heartbeat-file. If no scratch exists, the heartbeat still runs and the model decides what to do.
Keep it tiny (short checklist or reminders) to avoid prompt bloat.
Example scratch:
Schedule recurring checks with cron
Heartbeat scratch is prompt context, not a scheduler. Create each recurring check as a cron job so it has its own cadence, enable/disable state, and run history. Cron jobs can still target the main session when the check should use the normal conversation context. Older scratch may contain a structuredtasks: block. Run openclaw doctor --fix once after upgrading: Doctor converts every valid entry into an independently scheduled cron job, preserves its interval and previous last-run timing, and removes the retired block while keeping surrounding scratch prose. Runtime heartbeat turns do not parse tasks: text as schedules.
Doctor-created heartbeat task jobs keep heartbeat active-hours, cooldown, flood, and busy guards. Jobs due together can coalesce into one heartbeat turn. An occurrence outside active hours is skipped and tried again at its next cron occurrence.
Can the agent update its scratch?
Yes. During a heartbeat turn, the agent can pass ascratch value to heartbeat_respond to fully replace the monitor prose for future heartbeats. You can also ask it in a normal chat to run openclaw cron scratch <jobId> --set ..., or edit the scratch yourself with the same command. Manage recurring schedules with cron instead of writing scheduler syntax into scratch.
Manual wake (on-demand)
Useopenclaw system event to enqueue a system event and optionally trigger an immediate heartbeat:
If no
--session-key is given and multiple agents have heartbeat configured, --mode now runs each of those agent heartbeats immediately.
Related heartbeat controls in the same CLI group:
Cost awareness
Heartbeats run full agent turns. Shorter intervals burn more tokens. To reduce cost:- Use
isolatedSession: trueto avoid sending full conversation history (~100K tokens down to ~2-5K per run). - Use
lightContext: trueto skip workspace bootstrap files for heartbeat runs. - Set a cheaper
model(e.g.ollama/llama3.2:1b). - Keep the monitor scratch small.
- Use
target: "none"if you only want internal state updates.
Context overflow after heartbeat
Heartbeats preserve the shared session’s existing runtime model after the run completes, so a heartbeat that switched a session to a smaller local model (for example an Ollama model with a 32k window) can leave that model in place for the next main-session turn. If that next turn then reports context overflow, and the session’s last runtime model matches configuredheartbeat.model, OpenClaw’s recovery message calls out heartbeat model bleed as the likely cause and suggests a fix.
To avoid this: use isolatedSession: true to run heartbeats in a fresh session (optionally combined with lightContext: true for the smallest prompt), or choose a heartbeat model with a context window large enough for the shared session.
Related
- Automation - all automation mechanisms at a glance
- Background Tasks - how detached work is tracked
- Timezone - how timezone affects heartbeat scheduling
- Troubleshooting - debugging automation issues