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