Skip to main content
GET
List monitor types

Notes

  • To authenticate, you’ll need a Tako API key. It’s best practice to store it as an environment variable to avoid hardcoding sensitive credentials in your code.
  • Start here. Tako validates a monitor’s parameters against its type’s schema, so read the type before you call Create a monitor. This response is the authoritative list, and a type added since this page was written appears only in the response.
  • Each item returns parameters_schema, the JSON Schema that parameters must satisfy; description, what the type watches and when it fires; lookback_seconds, how far back an occurrence may have happened and still fire; subject_schema, the shape of the resolved subject the type returns; and fire_once_only.
  • firing_enabled reports whether this environment evaluates monitors. While it’s false, Create a monitor still accepts a monitor and the monitor stays active, but nothing evaluates it and nothing fires.

The registered types

Type names are namespaced domain.subtype.
stocks.pct_change and stocks.new_52w_extreme are state alerts. If you create one while its condition already holds, the next price update fires it. On a delayed feed, that update arrives as late as the feed’s delay.

Naming a subject

Each family names its subject a different way. For the three team types, the two ids combine:
  • game_id alone watches the whole game, and a firing reports both sides.
  • team_id alone follows that team’s games as they come.
  • Both together watch that team’s side of that one game.
Both ids come from List sports games: a row’s id is the game id, and its home.id and away.id are team ids.

What a firing sends

Each type sends its own set of payload fields to your notification channels. For the fields, see Webhook deliveries.

Authorizations

X-API-Key
string
header
required

Response

Every registered monitor type

items
MonitorTypeInfo · object[]
required
firing_enabled
boolean
required

Whether this environment evaluates monitors. While it's false, createMonitor still accepts a monitor and the monitor stays active, but nothing evaluates it and it reports no firings.