Water Leak Detector Events

These are the event types and detailed fields for Water Leak Detector events. Each event will have the following fields at minimum:

Field Name/Location Data Type Definition
DeviceId String DeviceID of the device changed
DeviceType String Type of the device in the event. Possible values: "DAS" (Smart Home Security), "WLD", "BuiltIn" (Built In Camera for Smart Home Security), "C1", "C2"
OccuredAt DateTime Date/Time stamp of the change
Subsystem String Source system of the change. Possible values: "Wld", "Das" (Smart Home Security), "Camera"
BackendId String Subsystem (backend) device ID
FrontendId String API facing Frontend ID, for example what would come in the GET /locations response
MessageBody JSON String Raw JSON source data from device facing system

These are the available Event Types:

  • WldCriticalBatteryEvent
  • WldCriticalBatteryResolvedEvent
  • WldDeviceOfflineEvent
  • WldDeviceOnlineEvent
  • WldHighHumidityEvent
  • WldHighHumidityResolvedEvent
  • WldHighTemperatureEvent
  • WldHighTemperatureResolvedEvent
  • WldLowBatteryEvent
  • WldLowBatteryResolvedEvent
  • WldLowHumidityEvent
  • WldLowHumidityResolvedEvent
  • WldLowTemperatureEvent
  • WldLowTemperatureResolvedEvent
  • WldWaterLeakEvent
  • WldWaterLeakResolvedEvent

WldCriticalBatteryEvent

No further data than minimum. Example:

    {
        "DeviceId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8",
        "FrontendId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8".
        "MessageBody": "{\"DeviceId\": \"96e2f501-624d-4cc6-8328-c885a3221dce\",  \"Type\":\" CriticalBattery\", \"BatteryRemaining\":\"5%\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":null}"
    }

WldCriticalBatteryResolvedEvent

The following additional fields are included:

Field Name/Location Data Type Definition
HappenedAt DateTime Resolution Date & Time Stamp

Example:

    {
        "HappenedAt": "2015-07-23T18:25:43.511Z",
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\":\" CriticalBattery\", \"BatteryRemaining\":\"5%\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"2015-07-23T18:25:43.511Z\"}"
    }

WldDeviceOfflineEvent

The following additional fields are included:

Field Name/Location Data Type Definition
CheckInPeriod Number Customer defined check in period of the device
LastDeviceCheckInTime DateTime Last date & time the device checked-in

Example:

    {
        "CheckInPeriod": 24.0,
        "LastDeviceCheckInTime": "2015-07-22T18:25:43.511Z",
        "DeviceId": "96e2f501-624d-4cc6-8328-c885a3221dce",
        "DeviceType": "WLD",
        "OccuredAt": "2015-07-23T18:30:43.511Z",
        "Subsystem": "Wld",
        "BackendId": "96e2f501-624d-4cc6-8328-c885a3221dce",
        "FrontendId": "96e2f501-624d-4cc6-8328-c885a3221dce",
        "MessageBody": "{\"DeviceId\": \"96e2f501-624d-4cc6-8328-c885a3221dce\", \"Type\": \"DeviceOffline\", \"Created\":\"2015-07-23T18:30:43.511Z\",\"Resolved\":\null, \"CheckInPeriod\":24, \"LastDeviceCheckInTime\":\"2015-07-22T18:25:43.511Z\"}"
    }

WldDeviceOnlineEvent

The following additional fields are included:

Field Name/Location Data Type Definition
CheckInPeriod Number Customer defined check in period of the device
LastDeviceCheckInTime DateTime Last date & time the device checked-in
LostAt DateTime Last date & time the device checked-in

Example:

    {
        "CheckInPeriod": 24.0,
        "LastDeviceCheckInTime": "2015-07-22T18:25:43.511Z",
        "LostAt": "2015-07-23T18:30:43.511Z"
        "DeviceId": "96e2f501-624d-4cc6-8328-c885a3221dce",
        "DeviceType": "WLD",
        "OccuredAt": "2015-07-23T18:30:43.511Z",
        "Subsystem": "Wld",
        "BackendId": "96e2f501-624d-4cc6-8328-c885a3221dce",
        "FrontendId": "96e2f501-624d-4cc6-8328-c885a3221dce",
        "MessageBody": "{\"DeviceId\": \"96e2f501-624d-4cc6-8328-c885a3221dce\", \"Type\": \"DeviceOffline\", \"Created\":\"2015-07-23T18:30:43.511Z\",\"Resolved\":\"2015-07-23T19:30:43.511Z\", \"CheckInPeriod\":24, \"LastDeviceCheckInTime\":\"2015-07-22T18:25:43.511Z\"}"
    }

WldHighHumidityEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert humidity (as percentage>

Example:

    {
        "Threshold": 21.0,
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"Threshold\":21.0,\"DeviceId\":\"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",\"AlarmId\":\"282f0f4d-29fb-48ca-8f94-e3a624065d6a\",\"Type\":\"HighTemperature\",\"Created\":\"2018-10-09T16:51:04\",\"Resolved\":null}"
    }

WldHighHumidityResolvedEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert humidity (as percentage>
HappenedAt DateTime Date and Time stamp when resolved

Example:

    {
        "Threshold": 21.0,
        "HappenedAt": "2018-10-09T17:51:04",
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"Threshold\":21.0,\"DeviceId\":\"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",\"AlarmId\":\"282f0f4d-29fb-48ca-8f94-e3a624065d6a\",\"Type\":\"HighTemperature\",\"Created\":\"2018-10-09T16:51:04\",\"Resolved\":\"2018-10-09T17:51:04\"}"
    }

WldHighTemperatureEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert temperature reading

Example:

    {
        "Threshold": 95,
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\":\" HighTemperature\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"\",\"Threshold\":\"95\"}"
    }

WldHighTemperatureResolvedEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert temperature reading
HappenedAt DateTime Date and Time stamp when resolved

Example:

    {
        "Threshold": 95,
        "HappenedAt": "2015-07-23T18:25:43.511Z",
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\":\" HighTemperature\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"2015-07-23T19:25:43.511Z,\"Threshold\":\"95\"}"
    }

WldLowBatteryEvent

No further data than minimum. Example:

    {
        "DeviceId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8",
        "FrontendId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8".
        "MessageBody": "{\"DeviceId\": \"96e2f501-624d-4cc6-8328-c885a3221dce\",  \"Type\":\" LowBattery\", \"BatteryRemaining\":\"10%\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":null}"
    }

WldLowBatteryResolvedEvent

The following additional fields are included:

Field Name/Location Data Type Definition
HappenedAt DateTime Resolution Date & Time Stamp

Example:

    {
        "HappenedAt": "2015-07-23T18:25:43.511Z",
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\":\"LowBattery\", \"BatteryRemaining\":\"10%\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"2015-07-23T18:25:43.511Z\"}"
    }

WldLowHumidityEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert humidity reading

Example:

    {
        "Threshold": 21.0,
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\": \"LowHumidity\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"\", \"Threshold\": \"48\" }"
    }

WldLowHumidityResolvedEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert humidity reading
HappenedAt DateTime Resolution Date & Time Stamp

Example:

    {
        "Threshold": 21.0,
        "HappenedAt": "2015-07-23T18=9:25:43.511Z",
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\": \"LowHumidity\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"2015-07-23T18:25:43.511Z\", \"Threshold\": \"48\" }"
    }

WldLowTemperatureEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert temperature reading

Example:

    {
        "Threshold": 32.0,
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\": \"LowTemperature\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"\", \"Threshold\": \"32\" }"
    }

WldLowTemperatureResolvedEvent

The following additional fields are included:

Field Name/Location Data Type Definition
Threshold Number Threshold alert temperature reading
HappenedAt DateTime Resolution Date & Time Stamp

Example:

    {
        "Threshold": 32.0,
        "HappenedAt": "2015-07-23T18=9:25:43.511Z",
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"DeviceId\": \"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",  \"Type\": \"LowTemperature\",  \"Created\":\"2015-07-23T18:25:43.511Z\", \"Resolved\":\"2015-07-23T18:25:43.511Z\", \"Threshold\": \"32\" }"
    }

WldWaterLeakEvent

No further data than minimum. Example:

    {
        "DeviceId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8",
        "FrontendId": "1d4d9bc2-4287-4072-9b47-b51dcb7371c8".
        "MessageBody": "{\"CheckInPeriod\":11.0,\"LastDeviceCheckInTime\":\"2018-06-19T06:21:15.3270827Z\",\"DeviceId\":\"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",\"AlarmId\":\"a292e716-8214-42f9-8bba-dcc57266ac96\",\"Type\":\"WaterLeak\",\"Created\":\"2018-10-09T16:51:04\",\"Resolved\":null}"
    }

WldWaterLeakResolvedEvent

The following additional fields are included:

Field Name/Location Data Type Definition
HappenedAt DateTime Timestamp original leak detection occured
MessageBody.Resolved DateTime Timestamp leak detection was resolved

Example:

    {
        "HappenedAt": "2018-10-09T16:51:04Z",
        "DeviceId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "DeviceType": "WLD",
        "OccuredAt": "0001-01-01T00:00:00Z",
        "Subsystem": "Wld",
        "BackendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "FrontendId": "a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7",
        "MessageBody": "{\"CheckInPeriod\":11.0,\"LastDeviceCheckInTime\":\"2018-06-19T06:21:15.3270827Z\",\"DeviceId\":\"a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7\",\"AlarmId\":\"a292e716-8214-42f9-8bba-dcc57266ac96\",\"Type\":\"LowHumidity\",\"WaterLeak\":\"2018-10-09T16:51:04\",\"Resolved\":\"2018-10-09T17:27:09\"}"
    }