Thermostat Events

`thermostat.climate_preset_activated`

A thermostat climate preset was activated.

{
  "climate_preset_key": "",
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A thermostat [climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "thermostat.climate_preset_activated",
  "is_fallback_climate_preset": true,
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "thermostat_schedule_id": "00000000-0000-0000-0000-000000000000",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

String

Key of the climate preset that was activated.

Object

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

ID of the event.

Enum (String)

Value: thermostat.climate_preset_activated

Boolean

Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat.

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the thermostat schedule that prompted the affected climate preset to be activated.

String (UUID)

ID of the workspace associated with the event.

`thermostat.manually_adjusted`

A thermostat was adjusted manually.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "cooling_set_point_celsius": 0,
  "cooling_set_point_fahrenheit": 0,
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [thermostat](/capability-guides/thermostats) was adjusted manually.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "thermostat.manually_adjusted",
  "fan_mode_setting": "auto",
  "heating_set_point_celsius": 0,
  "heating_set_point_fahrenheit": 0,
  "hvac_mode_setting": "off",
  "method": "seam",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

ID of the connected account associated with the event.

number

Temperature to which the thermostat should cool (in °C). See also Set Points.

number

Temperature to which the thermostat should cool (in °F). See also Set Points.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

ID of the event.

Enum (String)

Value: thermostat.manually_adjusted

Enum (String)

Desired fan mode setting, such as on, auto, or circulate.Possible values: auto, on, circulate

number

Temperature to which the thermostat should heat (in °C). See also Set Points.

number

Temperature to which the thermostat should heat (in °F). See also Set Points.

Enum (String)

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.Possible values: off, heat, cool, heat_cool, eco

Enum (String)

Method used to adjust the affected thermostat manually. seam indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.Possible values: seam, external

String (ISO 8601)

Date and time at which the event occurred.

String (UUID)

ID of the workspace associated with the event.

`thermostat.temperature_threshold_exceeded`

A thermostat’s temperature reading exceeded the set threshold.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [thermostat's](/capability-guides/thermostats) temperature reading exceeded the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "thermostat.temperature_threshold_exceeded",
  "lower_limit_celsius": 0,
  "lower_limit_fahrenheit": 0,
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "temperature_celsius": 0,
  "temperature_fahrenheit": 0,
  "upper_limit_celsius": 0,
  "upper_limit_fahrenheit": 0,
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

ID of the event.

Enum (String)

Value: thermostat.temperature_threshold_exceeded

number

Lower temperature limit, in °C, defined by the set threshold.

number

Lower temperature limit, in °F, defined by the set threshold.

String (ISO 8601)

Date and time at which the event occurred.

number

Temperature, in °C, reported by the affected thermostat.

number

Temperature, in °F, reported by the affected thermostat.

number

Upper temperature limit, in °C, defined by the set threshold.

number

Upper temperature limit, in °F, defined by the set threshold.

String (UUID)

ID of the workspace associated with the event.

`thermostat.temperature_threshold_no_longer_exceeded`

A thermostat’s temperature reading no longer exceeds the set threshold.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [thermostat's](/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "thermostat.temperature_threshold_no_longer_exceeded",
  "lower_limit_celsius": 0,
  "lower_limit_fahrenheit": 0,
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "temperature_celsius": 0,
  "temperature_fahrenheit": 0,
  "upper_limit_celsius": 0,
  "upper_limit_fahrenheit": 0,
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

ID of the event.

Enum (String)

Value: thermostat.temperature_threshold_no_longer_exceeded

number

Lower temperature limit, in °C, defined by the set threshold.

number

Lower temperature limit, in °F, defined by the set threshold.

String (ISO 8601)

Date and time at which the event occurred.

number

Temperature, in °C, reported by the affected thermostat.

number

Temperature, in °F, reported by the affected thermostat.

number

Upper temperature limit, in °C, defined by the set threshold.

number

Upper temperature limit, in °F, defined by the set threshold.

String (UUID)

ID of the workspace associated with the event.

`thermostat.temperature_reached_set_point`

A thermostat’s temperature reading is within 1 °C of the configured cooling or heating set point.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "desired_temperature_celsius": 0,
  "desired_temperature_fahrenheit": 0,
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [thermostat's](/capability-guides/thermostats) temperature reading is within 1 °C of the configured cooling or heating [set point](/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "thermostat.temperature_reached_set_point",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "temperature_celsius": 0,
  "temperature_fahrenheit": 0,
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

number

Desired temperature, in °C, defined by the affected thermostat’s cooling or heating set point.

number

Desired temperature, in °F, defined by the affected thermostat’s cooling or heating set point.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

ID of the event.

Enum (String)

Value: thermostat.temperature_reached_set_point

String (ISO 8601)

Date and time at which the event occurred.

number

Temperature, in °C, reported by the affected thermostat.

number

Temperature, in °F, reported by the affected thermostat.

String (UUID)

ID of the workspace associated with the event.

`thermostat.temperature_changed`

A thermostat’s reported temperature changed by at least 1 °C.

{
  "connected_account_custom_metadata": {},
  "connected_account_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2025-01-01T00:00:00.000Z",
  "customer_key": "",
  "device_custom_metadata": {},
  "device_id": "00000000-0000-0000-0000-000000000000",
  "event_description": "A [thermostat's](/capability-guides/thermostats) reported temperature changed by at least 1 °C.",
  "event_id": "00000000-0000-0000-0000-000000000000",
  "event_type": "thermostat.temperature_changed",
  "occurred_at": "2025-01-01T00:00:00.000Z",
  "temperature_celsius": 0,
  "temperature_fahrenheit": 0,
  "workspace_id": "00000000-0000-0000-0000-000000000000"
}

Properties

Object

Custom metadata of the connected account, present when connected_account_id is provided.

String (UUID)

ID of the connected account associated with the event.

String (ISO 8601)

Date and time at which the event was created.

String

The customer key associated with the device, if any.

Object

Custom metadata of the device, present when device_id is provided.

String (UUID)

ID of the affected device.

String

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

String (UUID)

ID of the event.

Enum (String)

Value: thermostat.temperature_changed

String (ISO 8601)

Date and time at which the event occurred.

number

Temperature, in °C, reported by the affected thermostat.

number

Temperature, in °F, reported by the affected thermostat.

String (UUID)

ID of the workspace associated with the event.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Thermostat Events

`thermostat.climate_preset_activated`

`thermostat.manually_adjusted`

`thermostat.temperature_threshold_exceeded`

`thermostat.temperature_threshold_no_longer_exceeded`

`thermostat.temperature_reached_set_point`

`thermostat.temperature_changed`

​thermostat.climate_preset_activated

​thermostat.manually_adjusted

​thermostat.temperature_threshold_exceeded

​thermostat.temperature_threshold_no_longer_exceeded

​thermostat.temperature_reached_set_point

​thermostat.temperature_changed

`thermostat.climate_preset_activated`

`thermostat.manually_adjusted`

`thermostat.temperature_threshold_exceeded`

`thermostat.temperature_threshold_no_longer_exceeded`

`thermostat.temperature_reached_set_point`

`thermostat.temperature_changed`