Skip to content

TriggerDefinition

What agent.trigger_set takes, with a prompt or a prompt_file, and what it and agent.trigger_remove answer, with its name. A trigger on a clock has every, and a cron expression a timezone where it is not UTC; overlap is skip, missed is run_once and jitter is 0 where they are left out. feed watches an RSS or Atom feed, or a list of them. A webhook has webhook in place of every, holding its secret, as ${NAME}, and verify, shared or standard; it is sent requests at POST /v1/hooks/{agent}/{trigger}, and its overlap is queue where it says none.

[k: string]: unknown
Property Type Description
name? string The trigger's name, which the path gives.
every? string A cron expression, or a duration such as 30m.
timezone? string The time zone a cron expression in every is read in, by its IANA name, as Europe/Berlin; Etc/UTC where it is left out. A duration counts elapsed time and takes none.
prompt? string What the agent is asked each time.
prompt_file? string In place of prompt, a file in the agent's tree: each time, the agent is asked to read it and do what it says. tools names files to read it with.
overlap? "skip" | "queue" What a firing does while a run is still going: skip it, or queue its prompt.
missed? "skip" | "run_once" What a trigger does about the firings it missed while down.
jitter? number Up to this many seconds of delay, chosen at random each time.
feed? string | string[] An RSS or Atom feed's URL, or a list of them: the agent is asked only when one has new entries, with them under the prompt. The first run only notes what a feed holds.
webhook? object In place of every: a service sends the trigger requests, each asked about once.
webhook.secret string The secret the service holds, as ${NAME}.
webhook.verify? "shared" | "standard" shared, where a request presents the secret as a bearer token or at the end of its path, or standard, where it is signed as Standard Webhooks says; shared unless set.