MQTT notifications allow Door Attendant to easily integrate with existing Home Automation systems.
MQTT notifications are sent asynchronously with respect to the gate entry, so there might be a slight delay of a few seconds from when the gate was opened to when the email is received.
Door Attendant will attempt to retry the notification in the event of an error, up to three (3) times. After the third failed attempt, no more attempts will be made and your endpoint will not receive a notification about the entry.
We support the MQTT/MQTTS protocol, versions 3.1.1. For MQTTS, we support certificate based authentication as well as traditional username and password.
This has been fully tested to work with Amazon AWS IoT, as well as other MQTT servers.
{
"entry_id": "01da269f597476a12cf80349f5ef434637e3d0e3",
"entry_time": "2016-01-01T09:15:00Z",
"attendant_id": "b81c4122-7bd6-465f-af83-357f2e06b3b9",
"attendant_name": "Apartment",
"location_phone_number": "+15556667777",
"location_name": "Visitor Garage"
}{
"entry_id": "01da269f597476a12cf80349f5ef434637e3d0e3",
"entry_time": "2016-01-01T09:15:00Z",
"attendant_id": "b81c4122-7bd6-465f-af83-357f2e06b3b9",
"attendant_name": "Apartment",
"location_phone_number": "+15556667777",
"location_name": "Visitor Garage",
"guest_name": "Jimmy",
"guest_pin": "1234"
}| Field | Description |
|---|---|
entry_id | This identifies this specific entry event. If you receive a request more than once with the same entry_id, you can safely ignore it. |
entry_time | The date and time that this entry event occurred. |
attendant_id | This is identifies the specific Attendant that the request was for. |
attendant_name | The name of the attendant. |
location_phone_number | The phone number of the location where the call originated. |
location_name | The name of the location where the call was from. (If you have not specified a name, then this will be the same as the phone number) |
guest_pin | This is the access code that a guest entered to open the gate/door. (This is only available if Access Control is enabled) |
guest_name | This is the name of the guest that entered. (This is only available if Access Control is enabled) |