Core Behavior
- Heartbeats run on gateway ticks when
gateway.heartbeat.enabledis true. - Each target uses
heartbeat.everyto decide due time (0disables the target). - Heartbeats read
HEARTBEAT.mdinstructions and should returnHEARTBEAT_OKwhen clear. - Runtime preflight resolves canonical file paths before model execution:
- global:
HEARTBEAT.md - team:
teams/<team>/HEARTBEAT.mdandteams/<team>/TEAM.md
- global:
- Runs skip before model execution when required files are missing, unreadable, or effectively empty.
HEARTBEAT_OK-only replies are suppressed by default for low-noise behavior.- Repeated identical alert payloads are suppressed for 24 hours.
Recommended Cadence Defaults
5m- very high-sensitivity operations triage15m- active project monitoring30m- balanced default (recommended)1h- normal background monitoring4hor8h- low-noise daily operations checks24h- daily hygiene checks
Team Pattern (Recommended)
Use team heartbeats for work that should stay scoped to one team.- Enable team heartbeat in Team Settings.
- Keep cadence at
30munless there is a clear need to increase. - Edit
teams/<team>/HEARTBEAT.mdwith an explicit checklist. - Keep default mode read-only unless explicit mutating steps are intentionally documented.
HEARTBEAT.md:
Visibility Controls
Heartbeat visibility is controlled by:- channel defaults:
channels.defaults.heartbeat - per-channel overrides:
channels.<channel>.heartbeat
showOk- sendHEARTBEAT_OKmessagesshowAlerts- send actionable alertsuseIndicator- emit visual/log status indicators
Active Hours
Useheartbeat.activeHours to constrain delivery windows:
start:"09:00"end:"18:00"timezone:"user","local", or IANA timezone like"America/New_York"