Events
Method
Description
Method
Description
DELETE
Unsubscribe a device from real-time events
https://api.honeywell.com/v3/events/subscribe/subsystem/{subsystem}/mac/{deviceId}
This API will unsubscribe a device from real-time events.
NOTE: this API requires Client Credentials authentication.
Valid subsystem types:
"TCC" - Round Smart Thermostats
"lcc" - T-Series Thermostats
"wld" - Water Leak Detector
"das" - Smart Home Security
"camera" - Awareness Cameras
POST
Subscribe Device
https://api.honeywell.com/v3/events/subscribe/subsystem/{subsystem}/mac/{deviceId}
This API will subscribe a device to real-time events, if you are allowed access.
NOTE: this API requires Client Credentials authentication.
Valid subsystem types:
"TCC" - Round Smart Thermostats
"lcc" - T-Series Thermostats
"wld" - Water Leak Detector
"das" - Smart Home Security
"camera" - Awareness Cameras
Example curl for Water Leak Detector:
curl -X POST \
'https://api.honeywell.com/v3/events/subscribe/subsystem/wld/mac/a15b7da4-3d19-4869-a48e-3cb4cf7f9fc7?apikey=apikeyhere' \
-H 'authorization: Bearer q1PvOeq0mqb6QwJDo1SBpCMF9kC6' \
-H 'cache-control: no-cache'
Example curl for Smart Home Security:
curl -X POST \
'https://api.honeywell.com/v3/events/subscribe/subsystem/das/mac/B82CA0032222?apikey=apikeyhere' \
-H 'authorization: Bearer rxpeJExfTpg4ytEU4CKO7ZZ7wfG8' \
-H 'cache-control: no-cache'
GET
Get Device Subscription State
https://api.honeywell.com/v3/events/subscribe/subsystem/{subsystem}/mac/{deviceId}
This API will return the current subscribed state of a device (if any).
NOTE: this API requires Client Credentials authentication.
Valid subsystem types:
"TCC" - Round Smart Thermostats
"lcc" - T-Series Thermostats
"wld" - Water Leak Detector
"das" - Smart Home Security
"camera" - Awareness Cameras
Example if device is not subscribed:
{
"code": 404,
"message": "Subscription not found for the given API key and device combination."
}
Example if device is subscribed:
{
"partnerId": "d42bd7c3-055e-4d42-9362-9a61e6da0958",
"referenceKey": "apiKeyHere",
"name": "App Test",
"subscribedSince": "2018-10-10T19:57:50.2146042Z"
}
POST
Create Partner Receiver
https://api.honeywell.com/v2/events/partner
Create a partner using a provided Event Hub connection string and Event Hub Name
NOTE: This API requires Client Credentials authentication and a valid connection string to a Microsoft Azure Event Hub.
Example:
{
"eventHubConnectionString": "Endpoint=sb://test.servicebus.windows.net/;SharedAccessKeyName=test;SharedAccessKey=test;TransportType=Amqp",
"eventHubPath": "test",
"name": "Events Test",
"referenceId": "YourApiKeyHere"
}
PUT
Set Events to Subscribe To
https://api.honeywell.com/v2/events/partner/events
This API changes the events you are subscribed to.
See list of valid events per device type here.
NOTE: this API requires Client Credentials authentication.
Example request body:
{
"eventIds": [
"DeviceOfflineEvent"
]
}
GET
Get Assigned Events
https://api.honeywell.com/v2/events/partner/events
This API will return the list of events currently subscribed.
NOTE: this API requires Client Credentials authentication.
Example:
[
{
"eventId": "DeviceOfflineEvent"
},
{
"eventId": "WldCriticalBatteryEvent"
},
{
"eventId": "DeviceSubscribedEvent"
},
{
"eventId": "DeviceUnsubscribedEvent"
}
]