Skip to main content

Architecture

Before diving into the API Reference, it helps to understand how Minut works — what it communicates, and how.

How a Minut device communicates​

Minut runs on batteries, so a lot of care goes into making them last. For most of the time the radio (Wi-Fi) is turned off, and it only wakes up when there's a reason to:

  1. Heartbeats — regular check-ins, roughly once an hour. A heartbeat carries all the sensor readings since the last one, some diagnostics, and a check for new configuration or firmware.
  2. Events — something out of the ordinary, such as a sudden rise in sound level, a temperature drop, or an alarm.

The important consequence is that the API is not real-time. Polling won't get you the latest readings any faster, because the device only reports periodically. Instead of polling, you react to events — either by registering a webhook or by fetching events after the fact.

A typical integration looks like this:

device ──(heartbeat / event)──▶ Minut backend ──(webhook POST)──▶ your endpoint

Events​

Most of what you'll build on is events. They're emitted when something is detected in the home, when a backend analysis produces a result, or when a user takes certain actions.

Every event has a type to branch on, a timestamp, a unique id, and references to the home, user and/or device it concerns. The exact field names differ slightly depending on whether you receive the event over a webhook or read it from the events endpoint — see the Events overview for the structure, and the API Reference for the full list of event types.

There are two ways to consume events:

  • Webhooks — Minut POSTs each event to an endpoint you control, as it happens. This is the recommended approach for reacting in real time.
  • Fetching events — pull events from the API after the fact, for backfilling history or reconciling anything you might have missed.
tip

For integrations we recommend subscribing to or reading events rather than polling sensor data — it's how you get the most up-to-date information without hammering the API.

Sensor data​

Heartbeats themselves aren't exposed, but the (much more useful) sensor data they carry is. The API provides continuous time series for measurements such as temperature, humidity, pressure, sound level and battery, with new data reported at least once per hour.

See Sensor Data for how to read the series, Configure Thresholds to trigger events when a measurement crosses a limit, and the API Reference for the complete set of available series.