cap_scheduler

Scheduler Management

Use this skill when the user needs to inspect or control timer-based schedule rules.

When to use

• The user asks to list current schedules.
• The user asks to add, update, or remove a schedule.
• The user asks to pause, resume, enable, disable, trigger, or reload a schedule.
• The user asks for a timer-based reminder, periodic check, timed automation, or scheduled agent wake-up.

Available capabilities

• scheduler_list: list all scheduler entries and runtime state.
• scheduler_get: get one scheduler entry by id.
• scheduler_add: add one scheduler entry from schedule_json string.
• scheduler_update: update one scheduler entry from schedule_json string.
• scheduler_remove: remove one scheduler entry by id.
• scheduler_enable: enable one scheduler entry by id.
• scheduler_disable: disable one scheduler entry by id.
• scheduler_pause: pause one scheduler entry by id.
• scheduler_resume: resume one scheduler entry by id.
• scheduler_trigger_now: trigger one scheduler entry immediately.
• scheduler_reload: reload scheduler definitions from disk.

Calling rules

• scheduler_add and scheduler_update input must be:

{
  "schedule_json": "<JSON string of one scheduler entry object>"
}

• schedule_json is a JSON string, not an object.
• Use a stable, unique id. scheduler_add fails if the id already exists. scheduler_update requires the id to already exist.
• scheduler_get, scheduler_remove, scheduler_enable, scheduler_disable, scheduler_pause, scheduler_resume, and scheduler_trigger_now take:

{
  "id": "schedule_id"
}

schedule_json object fields

• Required fields:
  • id: schedule unique id.
  • kind: one of once, interval, or cron.
• enabled: whether the schedule is active. Defaults to true.
• start_at_ms: absolute Unix epoch timestamp in milliseconds. Required for once. Optional for interval.
• end_at_ms: optional stop time in Unix epoch milliseconds for once or interval.
• interval_ms: interval period in milliseconds. Required for interval.
• cron_expr: 5-field cron expression for cron, in the form minute hour mday month wday.
• event_type: event type published to the router. Defaults to schedule.
• event_key: logical key for router matching and tracing. Defaults to id.
• source_channel: event source channel. Defaults to time.
• chat_id: optional target chat id when downstream router actions need one.
• content_type: event content type. Defaults to trigger.
• session_policy: one of trigger, chat, global, ephemeral, nosave. Defaults to trigger.
• text: optional event text payload. For agent wake-up rules, use this as the instruction text.
• payload_json: optional structured payload. Defaults to {}. It may be written either as a JSON string or as a JSON object in the item itself.
• max_runs: max trigger count. 0 means unlimited.