Automation payloads

What a job runs and where it runs: the four payload kinds, their flags, and the four session execution styles. Part of the Automations guide.

Payloads

Every job carries exactly one payload kind, chosen by flag:

Doctor converts former heartbeat monitors into ordinary editable agentTurn jobs. Gateway startup no longer reconciles a system-owned monitor from config. Use openclaw automations list --all to inspect both enabled and disabled jobs. See Heartbeat migration.

The weekly Skill Workshop curator (declaration key skill-collection-review:<agentId>, and the older skillCollectionReview payload kind) is retired. The Gateway deletes those stored rows when it loads the cron store and creates no replacement; the declaration-key namespace stays reserved. Learned-skill cleanup now runs without a schedule; see Unused-skill cleanup.

Agent-turn options

New jobs that can run tools always store an explicit tool policy. A job created without --tools (or with *) stores *: each run uses the owner session's current tool policy, including its group, agent, sandbox, and runtime restrictions. An agent that requests a finite list is capped to the tools available to its creating turn and cannot widen the stored list. If a requested name, group, or pattern matches no captured tool, agent-created jobs and agent tool-cap edits fail with that entry in the error instead of saving a partial list. This includes Codex app tools that the creator runtime cannot carry. Use a supported tool name and runtime, or explicitly remove the unavailable entry. automations edit --clear-tools restores *. Existing jobs that predate an explicit tool policy retain their current behavior until their tool policy is explicitly edited or the job is recreated. Agent-created script payloads, condition triggers, and jobs whose creator captured Codex app authority store the creating turn's tools instead: scripts reach MCP only through servers their list names, and app authority is bound to that list.

Earlier releases saved a copy of the creating turn's tool list on agent-created agent turns. That copy could miss tools the creator had, such as the native shell. Those jobs now run with their owner conversation's tools, like a * job; the stored copy is left as it is. Jobs whose creator captured Codex app authority keep using their copy.

Changing an account-bound job to a payload that does not run tools and later back to an agent turn preserves its account restriction. A payload conversion does not reauthorize that job as an operator-created job.

Doctor checks scheduled tool authority only for agent turns, script payloads, and jobs with a condition script. A command payload without a condition script does not need agent-tool provenance; its retained account restriction stays unchanged.

Management edits cannot restore missing policy metadata as operator authority. For a legacy job that has lost its policy, an authenticated operator can explicitly reauthorize it, or an authenticated creator can recreate it with a fresh tool cap.

When the creator's exec capability is fixed to the Gateway, the automation also retains that target. With tools.exec.host: "auto", the saved target determines placement. A conflicting current explicit host setting or required sandbox isolation blocks the command instead of moving it to another host. Current tool and approval policies still apply.

With message in the tool cap, scheduled agent turns can read messages and channel information on supported channel plugins without an inbound chat. Operator-created jobs use the current operator read policy. Agent-created jobs retain their recorded creator origin and account, and the channel's delegated read restrictions still apply. Delivery settings do not grant read access.

Scheduled agent turns can inspect their own job and remove it when finished, even without an interactive sender. This self-scoped automations tool does not grant administrator access or control over other jobs, and explicit tool-policy denials still apply.

An authenticated operator turn can schedule an agentTurn back into its exact existing conversation with sessionTarget: "session:<same session key>". New jobs retain the original authenticated source privately, so the continuation can finish authorized work, such as inspecting and merging that conversation's PR, without another message from the operator. Each occurrence revalidates the original operator scopes, role, device, access grant, model restrictions, and exact session identity under current policy. This preserves the original operator scope ceiling; it is not a new PR-only permission or a blanket grant to automations. The stored tool cap, sandbox, and current tool denials still apply. Scheduled automation management remains self-scoped.

This source is not inferred for existing jobs, guests, isolated/current targets, scripts, or another conversation. Executable edits discard it unless an authenticated creator schedules a fresh continuation; display-only edits retain it. Disabling, removing, or replacing the job or session retires the active occurrence. Re-enabling the job does not revive a revoked occurrence.

While an at agent-turn continuation in an explicitly named conversation waits for a result, it can call automations with action: "next_check" and in: "3m" to rearm that same job. It does not create a new job or change its task, target, or permissions. Without a next-check proposal, ordinary one-shot completion and deleteAfterRun behavior are unchanged.

Manual runs use the same scheduled execution context as timer-fired runs after the request passes admission. Ending the chat turn or tool call that started a run does not expire the job's tool access. The job still uses its stored authority and current tool restrictions; starting it manually does not grant the caller's extra permissions to the job.

Current global, agent, profile, and provider tool policy is checked when each new scheduled message invocation starts. Configuration changes apply to later invocations; an invocation already admitted retains its configuration. Disabling or removing a job, withdrawing its message capability, or revoking its caller or plugin authority stops further affected reads from that occurrence, including pending reads before another provider request or result delivery. Re-enabling the job does not restore an occurrence's revoked access.

A new account-bound job created by a verified local administrator retains that authenticated local source, allowing provider-permitted reads through its saved creator account. Editing its toolsAllow cap from the same local source explicitly reauthorizes an existing job. Description, display-label, and exact no-op edits preserve the recorded source. Changes to model-facing names, prompts, tools, schedules, or other executable behavior need fresh source authorization and clear the old source when none is present. Remote management alone cannot supply local-source authorization, and older jobs without a provable origin remain blocked until reauthorized or recreated from a fresh authorized source.

Scheduled turns can also edit, delete, pin, and unpin Discord messages. Agent-created jobs use their recorded creator account and Discord's delegated target restrictions. Operator-created jobs use Discord's operator target policy. Trusted operator jobs can additionally use channel-edit, including the existing channel and thread edit options; account-created jobs do not inherit operator administration.

For these writes, the job needs message in its tool policy, an enabled account and action, and the bot's required Discord permissions. Use an updated Discord plugin with scheduled write support.

Account-bound jobs can use Discord channel-edit when an authenticated Discord turn has authorized their current definition. OpenClaw privately retains that requester's Discord account and sender identity, and Discord's current channel or thread permissions must allow the edit. The original session creator and a configured OpenClaw owner are not substitutes for those native permissions.

Executable edits from the job's owning conversation and account bind the job to the current authorized editor. This includes the prompt, model, name, schedule, delivery, and tool policy. An executable edit without a matching authenticated Discord requester clears this permission and stops further native actions from the old occurrence. Description and display-label changes preserve it.

Older jobs, jobs edited by older writers, and jobs whose requester authorization was cleared need fresh authorization before channel-edit can run. From the original Discord conversation and account, ask the agent to edit the job with an explicit finite toolsAllow list including message, or recreate it there. If its execution authorization is also missing, recreate it from that conversation; management access alone does not restore the missing authorization. The editor must already have automation-management access. Other job behavior keeps its existing policy; a CLI edit cannot invent a Discord requester. These requester facts are omitted from public job results, and no new setting is needed.

Channel-name lookup and subsequent write requests retain the current job and plugin authority. Configuration changes apply to the next message invocation; disabling or narrowing the job itself stops later requests and retries in the current invocation. A confirmed write still returns its result if authority ends while the response is pending.

Inference account continuity

New isolated agent-turn jobs privately retain their selected stored inference account and compatible authentication route. OAuth and API keys can remain enabled together: changing interactive defaults, profile order, or the job’s plain model selection does not switch the job’s account or billing route. Automatic ownership remains distinct from an explicit user profile pin. Token refresh within the same authorization is allowed; deleting, replacing, or revoking that authorization stops the job rather than falling back to another account. Model and route compatibility still apply.

To change an account deliberately, update the job with a model/profile selection, for example --model "openai/gpt-4.1@work". This captures a fresh authorization. For legacy jobs without a recorded inference owner, openclaw doctor --fix records the account the job's next unbound run would use: an explicit selection, or else the first account in the run's normal account order, ignoring temporary rate-limit cooldowns. With auth.order set, that is the account every earlier run used; without it, runs rotated between accounts of the same type by last use, and Doctor records one of them. When several accounts are eligible, Doctor names the others and the command to change the choice. Doctor uses normal automation model selection, preserves inherited defaults and fallback lists, leaves existing bindings unchanged, and backs up cron state before committing. Missing accounts, and personal accounts needing their owner's authorization, are left unchanged with job-specific adoption instructions.

Managed updates and the standard container entrypoint run repairing Doctor before activation. A manual source upgrade must include openclaw doctor --fix before starting the Gateway. Startup reports potentially unmigrated host-account jobs before scheduling; it does not capture credentials or rewrite jobs.

Keys in the environment or provider config have no stored account to record. A job on such a route stays unbound and runs on that key; once a stored account becomes eligible for its route, the job stops with the adoption instructions instead of switching to that account. Job creation follows the same rule. An account refusal ends the run; it never falls back to another model or provider. Credentialless models remain usable without an account. Native runtime-owned jobs retain their runtime’s existing authorization checks, and a native connection cannot silently replace a job’s recorded host-managed inference account. An explicit update from an authorized native creator can adopt its runtime authority. Moving a job to an agent with a different credential owner requires explicit account adoption. Tool and delivery accounts remain separate from the inference account.

--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.

A fallback after a provider timeout continues the same scheduled turn and reuses its saved user input. Failed attempts do not complete the turn or duplicate the scheduled prompt.

Pick the model for the job's difficulty, not the agent's default. Routine automation - summaries, triage, classification, status checks - runs well on a lighter model, which is cheaper and faster per run and adds up across a schedule. Keep your default model for jobs that need deep reasoning, and use --fallbacks when a light primary should escalate on failure.

Model-selection precedence for isolated jobs, highest first:

1. Per-job payload model (explicit config; a disallowed model fails the run)
2. Gmail hook model override (only when the run came from Gmail and that override is allowed)
3. User-selected stored automation-session model override
4. Agent/default model selection

Fast mode follows the resolved live selection. Isolated automation resolves it in this order: stored session fastMode, per-agent agents.entries.*.fastModeDefault, global agents.defaults.fastModeDefault, then selected-model params.fastMode. Auto mode uses the model's params.fastAutoOnSeconds cutoff, defaulting to 60 seconds.

When a runtime reports token usage without a cost, automation estimates use the selected agent's local models.json prices and the model metadata retained for that run.

If a run hits a live model-switch handoff, the scheduler retries with the switched provider/model and persists that model selection for the active run. A job with a recorded inference account retains that account and its compatible authentication route; a switch cannot adopt a different account. Retries are bounded: after the initial attempt plus 2 switch retries, the scheduler 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 check instead of a request storm. Skipped preflight runs do not increment execution-error backoff. They use the existing failure-alert policy without requiring failureAlert.includeSkipped; recurring jobs remain enabled and recover automatically when a later preflight finds the provider reachable.

Client-side preflight timeouts are not cached. The next scheduled run checks the endpoint again instead of inheriting a timeout from another run.

The local check opens and closes a TCP connection without sending HTTP requests or provider credentials, so authenticated local servers do not log spurious /models authorization failures. TLS, authentication, and model errors are handled by inference. Endpoints routed through a managed proxy defer connectivity checks to inference instead of testing a direct connection.

Job scratch and quiet results

Each job can keep private task context in scratch stored in the shared state database, capped at 256 KiB. Present scratch is injected into the job's bounded run context. It is omitted from job lists, full job definitions, and run-history responses.

openclaw automations scratch <job-id> --set "Check only for newly blocked work."openclaw automations scratch <job-id> --json

Scratch updates use revision compare-and-swap. The CLI reads the current revision before writing; --expected-revision <n> pins a known revision. During an automation turn, the automations tool exposes self-scoped scratch_get, scratch_set, and record_result actions. They do not grant access to another job's scratch or settings.

scratch_get returns content and the current revision. scratch_set replaces the complete content, or clears it with null, and requires expectedRevision from that read. If the prompt says scratch was shortened, reread the complete content before replacing it. On a revision conflict, read again and reconcile the content instead of overwriting another edit.

Use a normal final reply for a visible result and NO_REPLY for silence. record_result accepts one outcome (no_change, progress, done, blocked, or needs_attention) and a nonempty summary capped at 2000 characters. It records the result without sending a notification by itself. Meaningful outcomes are retained in ordinary run history and bounded session context, including when the final reply is silent; this is not a delivery retry queue. no_change keeps runner delivery silent without hiding execution failures. Adaptive scheduling still uses next_check on a paced job. Scratch is context, not another scheduler: runtime does not parse tasks: blocks or read HEARTBEAT.md.

With payload.skipIfScratchEmpty: true (--skip-if-scratch-empty), blank text, comments, headings, fence markers, and empty checklist stubs count as an empty checklist. Removing scratch with --unset is different: missing scratch does not suppress a run. Disable the job when it should stop regardless of scratch.

Command payloads

Command payloads run scripts inside the Gateway scheduler without starting a model-backed turn. They execute on the Gateway host, capture stdout/stderr, record the run in the job's run history, and reuse the same announce, webhook, and none delivery modes as agent-turn jobs.

openclaw automations create "*/15 * * * *" \  --name "Queue depth check" \  --command "scripts/check-queue.sh" \  --command-cwd "/srv/app" \  --announce \  --channel telegram \  --to "-1001234567890"

--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, the scheduler 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 automation silent-token suppression and posts nothing back to chat.

When the run deadline stops a command, run history retains its captured output and command timeout reason after bounded process cleanup. Completion delivery does not start after that deadline.

Script payloads

Script payloads run headlessly in the same code-mode executor as trigger scripts, without starting a conversational agent turn. They are available by default; setting cron.triggers.enabled: false disables creation and execution of script payloads together with condition-trigger scripts and stream schedules. Script jobs support only main and isolated session targets.

Scripts get only self-scoped automations actions (status, list, get, remove, runs, and next_check), with no add, update, run, or wake. To resume a conversation later, schedule an agentTurn instead.

openclaw automations create "0 * * * *" \  --name "Hourly queue check" \  --script ./automation/check-queue.js \  --script-timeout-seconds 300 \  --script-tool-budget 50 \  --session isolated \  --announce

Use --script <file|-> to read JavaScript from a file or stdin. The CLI preserves leading and trailing spaces in file paths; quote the path as one shell argument. The timeout defaults to 300 seconds and is capped at 900; the tool budget defaults to 50 calls and is capped at 200. These payload budgets are separate from the smaller trigger-gate evaluation budgets.

Script payloads can call configured MCP server tools as MCP.<server>.<tool>({ ...input }), like interactive Code Mode. MCP is opt-in per server: name each server in the job's toolsAllow (--tools) with an exact tool such as wispr-flow__search_meetings or a server-scoped glob such as wispr-flow__*. A wildcard *, a missing toolsAllow, a glob without a server prefix, or a script that never mentions MCP starts no server. Within a named server, the owning agent's tool policy still applies. Each run starts its own runtime for the named servers, counts connection time against the script timeout and each call against the tool budget, and retires the runtime when the run ends. A named server that fails to start is absent from MCP; if the script then fails, the run error ends with MCP server "<name>" is unavailable: <reason>. See Event triggers for the shared details.

The script may return an object with these optional fields:

• notify: Text delivered through the job's announce, webhook, or none delivery mode. If omitted, nothing is delivered. For a main job, the text becomes a system event.
• wake: "now" requests immediate session processing of notify (or a compact completion event). The legacy "next-heartbeat" value assigns the notice to an eligible scheduled automation; a missing target is reported.
• state: JSON state, capped at 16 KB and persisted only after a successful run. The next run receives a frozen copy as trigger.state, matching trigger scripts. Because that namespace has one persisted owner, a script payload cannot be combined with a condition trigger on the same job.
• nextCheck: A duration such as "15m". It is valid only for jobs with pacing enabled and uses the same pacing clamp as agent-turn proposals.

Throws, timeouts, exhausted tool budgets, invalid results, and nextCheck without pacing are normal automation run errors: they enter run history, backoff, and failure-alert handling without persisting returned state.

Plugin reloads invalidate cached script preparation. If a plugin retires during setup, OpenClaw refreshes the tools once before starting the script, within the original deadline. A failure after the script starts never triggers this setup retry. If the refresh fails, run history and failure alerts explain that automatic setup recovery failed and the script did not run.

Changing a running job's script payload or saved state protects that edit from the old script's returned state, including when completion is recovered after a Gateway restart. The completed run still retains its history.

Authoring recurring jobs

A recurring job re-runs the same instructions on every fire, so anything the model works out from scratch costs the same time and tokens each run. Keep the model for judgment and move the repeatable parts into code:

• Put listing and diffing, dedupe, and checkpoints or watermarks in a workspace script that the payload runs in a single exec call.
• Keep detailed instructions in a workspace file next to the script and have the message reference it (for example, "Follow scripts/<job>.md"), so most fixes need only workspace file edits, not a job update.
• Have the message name the exact tool ids and argument shapes the run should use, instead of asking the model to discover them.
• Cap toolsAllow to the tools the run actually needs.
• When a script can decide there is nothing to do, use a condition trigger, a command payload, or a script payload so quiet fires skip the model. Scripts can call a configured MCP server only when toolsAllow names it (<server>__<tool> or <server>__*). Triggers and script payloads are unavailable when cron.triggers.enabled is false.
• When a run fails, make it fail instead of posting the error yourself: throw from trigger or script payload JavaScript, or exit non-zero from a command payload. A script that returns an error field still succeeds. The scheduler owns failure accounting: only the failure alert waits for consecutive failed runs; the run's own output still follows the job's delivery setting.

Execution styles

Codex apps in scheduled automations

Codex-created automations can retain the app IDs and permission ceiling available to the authenticated creator thread. At execution, OpenClaw requires the same prepared Codex profile and account, then narrows the stored cap against current app policy. Revoked apps, account/runtime changes, and interactive approval requirements stop execution with a recovery message; they never fall back to broader or different credentials. Older jobs without a captured app envelope continue their ordinary non-app behavior; recreate or reauthorize one only when it needs Codex app access. See Native Codex plugins.

Agent-turn jobs default to the creating conversation when the create request carries session context. Callers without a session key, including CLI and API callers that do not supply one, fall back to isolated. System events default to main; command and script payloads still default to isolated.

With announce, agent, command, and script results belong to the chat or topic that receives them. A different delivery destination gets the result instead of the creating conversation; without an external route, the creating conversation receives it. An isolated run still does not read that conversation's history. See Automation delivery for generation checks and duplicate prevention.