Alert Object

The Alert object represents an alert generated either by a thermostat or user which requires user attention. It may be an error, or a reminder for a filter change. Alerts may not be modified directly but rather they must be acknowledged using the Acknowledge Function.

Properties

Name Type Read Only Required Description
acknowledgeRef String yes no The unique alert identifier. This is required to acknowledge an alert.
date String yes no The alert date: YYYY-MM-DD
time String yes no The alert time: HH:MM:SS
severity String yes no The alert severity. Values: low, medium, high.
text String yes yes The alert message text. Will be truncated to 500 characters if longer.
alertNumber Integer yes no The ecobee alert message identifier
alertType String yes no The type of alert this is. Values: alert, demandResponse, emergency, message, pricing.
isOperatorAlert Boolean yes no Whether the alert was generated by the thermostat owner
reminder String yes no Whether a reminder will be sent.
showIdt Boolean yes no Whether to show the alert on the thermostat.
showWeb Boolean yes no Whether to show the alert on the ecobee web portal.
sendEmail Boolean yes no Whether to send an alert email to the thermostat user.
acknowledgement String yes no The user acknowledgement type. Values: accept, decline, defer, unacknowledged.
remindMeLater Boolean yes no Whether to remind the user at a later time about the alert.
thermostatIdentifier String yes no The identifier of the thermostat that generated the alert
notificationType String yes no The type of Alert or reminder. Possible values are: alert, hvac, furnaceFilter, humidifierFilter, dehumidifierFilter, ventilator, ac, airFilter, airCleaner, uvLamp, temp, lowTemp, highTemp, lowHumidity, highHumidity, auxHeat, auxOutdoor. If the configuration for the specific alert type is required, see NotificationSettings

The field 'alertNumber' holds a value that represents a number used as an error code. The table below shows different alert numbers a user can encounter along with a brief description for each number:

Alert Numbers

Code Description
611Invalid registration password
1000Cold temp alert
1001Hot temp alert
1002Sensor activated shutting down compressor
1003Problem with furnace/boiler heating
1004Problem with heatpump heating
1005Problem with heatpump heating
1006Problem with cooling
1007Communication to EI failed
1009Problem with aux heat, running too much
1010Aux heat used with high outdoor temp
1011Sensor activated switching to occupied
1012Sensor activated switching to unoccupied
1013Sensor activated disabling AC
1014Sensor activated setting temp up/down
1015Sensor activated
1016Sensor activated opening/closing relay
1017Sensor activated turning on fan
1018Sensor activated shutting down aux heat
1019Sensor activated shutting down heating/cooling
1020Low humidity alert
1021High humidity alert
1022Sensor activated shutting down heat
1024Sensor activated humidifier
1025Sensor activated dehumidifier
1026Low battery
1027Remote sensor detected
1028Remote sensor not communicating
1029Remote sensor re-established
1030Invalid current temp reading
1031Current temp reading restored
1032Faulty humidity sensor
1033Faulty humidity sensor
1034Incorrect Zigbee module installed
3130Furnace maintenance reminder
3131Humidifier maintenance reminder
3132Ventilator maintenance reminder
3133Dehumidifier maintenance reminder
3134Economizer maintenance reminder
3135UV maintenance reminder
3136AC maintenance reminder
3137Air filter reminder (ClimateMaster only)
3138Air cleaner reminder (ClimateMaster only)
3140Hvac maintenance reminder
4000ClimateTalk
4100 - 4199ClimateTalk device alert major/minor fault codes
4200 - 4299ClimateTalk device lost communications
4300 - 4399ClimateTalk system message from device
6000DR voluntary alert
6001DR voluntary utility message
6002 - 6005DR voluntary alerts
6100DR mandatory alert
6101DR mandatory message
6102DR mandatory alert
6200Monthly cost exceeded
6201Monthly projected cost exceeded
6300Network join successful
6301Network join failed
7000Registration confirmation
7001Registration Remind me alert
7002Web initiated messages - such as Utility welcome message or similar
8000 - 8299Daikin Indoor/Outdoor Unit Alerts
8300 - 8599ClimateMaster Heatpump/hardware Unit Alerts
9000ClimateMaster fault
9255ClimateMaster fault max
9500ClimateMaster disconnected
9755ClimateMaster disconnected max

Back To Top