Ticker Docs
Tools

list_watch_triggers

List Watch Triggers

Reads only.

Use this for the catalog of watch trigger keys and their valid ranges. Use get_watch_defaults instead for which of them the account arms by default. The catalog of triggers a watched event can arm, and the only reference for what watch_event and update_watch accept. Each entry has key (what you pass in the triggers map), label and description in the words the app uses, default_enabled (whether a fresh star arms it), and params, each with its range: a value outside min and max, or an option not in options, is refused by watch_event, update_watch and set_watch_defaults with an error naming the field and the valid range, and nothing is written. Some carry a caveat naming what the trigger cannot tell you. Call it before arming a watch; it costs nothing against your daily allowance.

Parameters

None.

On this page