Docs »

Automations »

Triggers »

automation.timer

automation.timer automations are executed by timers at a future time, or at various intervals. They support continuations to pause and resume between executions.

On the first invocation of the timer, an automation is selected using events KATA. This may optionally provide inputs.

Inputs

The automation dictionary starts with the following values:

Key Type Notes
timer_* dictionary The parent timer dictionary
inputs dictionary Custom input values from the caller

Outputs

await:

When the automation pauses in the await state, the timer is rescheduled to continue at a future date.

Key Type Notes
until timestamp The future UNIX timestamp to resume the automation at the current point


start:
  # Run some commands
  await:
    until@date: +5 mins


return:

When the automation concludes:

  • If the timer has a recurring schedule, it is rescheduled for the next occurrence.

  • Otherwise, a one-shot timer is disabled (or optionally deleted) at conclusion.

    Key Type Notes
    delete bool true to delete the timer when complete