mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-20 21:51:28 +00:00
cd07ebef99
* Docs: fix stale flows command references * Docs: address flows review comments * docs: remove stale flows subtree from cli index * fix: correct flows docs to tasks (#58690) (thanks @neeravmakwana) --------- Co-authored-by: Ayaan Zaidi <hi@obviy.us>
69 lines
3.8 KiB
Markdown
69 lines
3.8 KiB
Markdown
---
|
|
summary: "Overview of all automation mechanisms: heartbeat, cron, tasks, hooks, webhooks, and more"
|
|
read_when:
|
|
- Deciding how to automate work with OpenClaw
|
|
- Choosing between heartbeat, cron, hooks, and webhooks
|
|
- Looking for the right automation entry point
|
|
title: "Automation Overview"
|
|
---
|
|
|
|
# Automation
|
|
|
|
OpenClaw provides several automation mechanisms, each suited to different use cases. This page helps you choose the right one.
|
|
|
|
## Quick decision guide
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
A{Run on a schedule?} -->|Yes| B{Exact timing needed?}
|
|
A -->|No| C{React to events?}
|
|
B -->|Yes| D[Cron]
|
|
B -->|No| E[Heartbeat]
|
|
C -->|Yes| F[Hooks]
|
|
C -->|No| G[Standing Orders]
|
|
```
|
|
|
|
## Mechanisms at a glance
|
|
|
|
| Mechanism | What it does | Runs in | Creates task record |
|
|
| ---------------------------------------------- | -------------------------------------------------------- | ------------------------ | ------------------- |
|
|
| [Heartbeat](/gateway/heartbeat) | Periodic main-session turn — batches multiple checks | Main session | No |
|
|
| [Cron](/automation/cron-jobs) | Scheduled jobs with precise timing | Main or isolated session | Yes (all types) |
|
|
| [Background Tasks](/automation/tasks) | Tracks detached work (cron, ACP, subagents, CLI) | N/A (ledger) | N/A |
|
|
| [Hooks](/automation/hooks) | Event-driven scripts triggered by agent lifecycle events | Hook runner | No |
|
|
| [Standing Orders](/automation/standing-orders) | Persistent instructions injected into the system prompt | Main session | No |
|
|
| [Webhooks](/automation/webhook) | Receive inbound HTTP events and route to the agent | Gateway HTTP | No |
|
|
|
|
### Specialized automation
|
|
|
|
| Mechanism | What it does |
|
|
| ---------------------------------------------- | ----------------------------------------------- |
|
|
| [Gmail PubSub](/automation/gmail-pubsub) | Real-time Gmail notifications via Google PubSub |
|
|
| [Polling](/automation/poll) | Periodic data source checks (RSS, APIs, etc.) |
|
|
| [Auth Monitoring](/automation/auth-monitoring) | Credential health and expiry alerts |
|
|
|
|
## How they work together
|
|
|
|
The most effective setups combine multiple mechanisms:
|
|
|
|
1. **Heartbeat** handles routine monitoring (inbox, calendar, notifications) in one batched turn every 30 minutes.
|
|
2. **Cron** handles precise schedules (daily reports, weekly reviews) and one-shot reminders.
|
|
3. **Hooks** react to specific events (tool calls, session resets, compaction) with custom scripts.
|
|
4. **Standing Orders** give the agent persistent context ("always check the project board before replying").
|
|
5. **Background Tasks** automatically track all detached work so you can inspect and audit it.
|
|
|
|
See [Cron vs Heartbeat](/automation/cron-vs-heartbeat) for a detailed comparison of the two scheduling mechanisms.
|
|
|
|
## Older ClawFlow references
|
|
|
|
Older release notes and docs may mention `ClawFlow` or `openclaw flows`, but the current CLI surface in this repo is `openclaw tasks`.
|
|
|
|
See [Background Tasks](/automation/tasks) for the supported task ledger commands, plus [ClawFlow](/automation/clawflow) and [CLI: flows](/cli/flows) for compatibility notes.
|
|
|
|
## Related
|
|
|
|
- [Cron vs Heartbeat](/automation/cron-vs-heartbeat) — detailed comparison guide
|
|
- [ClawFlow](/automation/clawflow) — compatibility note for older docs and release notes
|
|
- [Troubleshooting](/automation/troubleshooting) — debugging automation issues
|
|
- [Configuration Reference](/gateway/configuration-reference) — all config keys
|