get https://{base_url}/api/
Check the example for different webhooks and sample data.
Example responses
Note: activity_time is in UTC timestamp
Hub Online/Offline:
{
"hub_id": "8a3fc595-a355-4fc0-bac2-5e9143a885d8",
"home_name": "76657",
"serial_no": "76657",
"address": "",
"pms_datapull_id": "",
"device_type": "hub",
"message_type": "online",
"details": "Online",
"activity_time": "2023-09-25 03:24:53 UTC"
}
Hub Heartbeat:
{
"hub_id": "78bf6b20-9f5f-4564-8cd0-bd0f07ab0ca9",
"home_name": "30011, 5310 West Barry Avenue Common Door",
"serial_no": "30011",
"address": "5310 West Barry Avenue Common Door, Chicago, IL, 60641",
"pms_datapull_id": "Rently02|221",
"message_type": "heartbeat",
"device_type": "hub",
"details": "2020-09-10T09:24:44.657Z",
"activity_time": 1546862518845
}
Hub Unplugged/Plugged:
{
"hub_id": "78bf6b20-9f5f-4564-8cd0-bd0f07ab0ca9",
"home_name": "30011, 5310 West Barry Avenue Common Door",
"serial_no": "30011",
"address": "5310 West Barry Avenue Common Door, Chicago, IL, 60641",
"pms_datapull_id": "Rently02|221",
"message_type": "power_source",
"device_type": "hub",
"details": "battery/external",
"activity_time": 1546862518845
}
Hub unassigned From Account:
{
"hub_id": "78bf6b20-9f5f-4564-8cd0-bd0f07ab0ca9",
"home_name": "30011, 5310 West Barry Avenue Common Door",
"serial_no": "30011",
"address": "5310 West Barry Avenue Common Door, Chicago, IL, 60641",
"pms_datapull_id": "Rently02|221",
"message_type": "unassigned_from_account",
"device_type": "hub",
"details": 5,
"activity_time": 1546862518845
}
Lock:
{
"hub_id": "78bf6b20-9f5f-4564-8cd0-bd0f07ab0ca9",
"home_name": "30011, 5310 West Barry Avenue Common Door",
"serial_no": "30011",
"address": "5310 West Barry Avenue Common Door, Chicago, IL, 60641",
"pms_datapull_id": "Rently02|221",
"device_id": "af84cf4a-6051-4653-9f01-0a868d4dd0c9",
"device_name": "lock-8",
"device_type": "lock",
"message_type": "Lock",
"User": "Auto",
"activity_time": 1546862518845
}
Unlock:
{
"hub_id": "78bf6b20-9f5f-4564-8cd0-bd0f07ab0ca9",
"home_name": "30011, 5310 West Barry Avenue Common Door",
"serial_no": "30011",
"address": "5310 West Barry Avenue Common Door, Chicago, IL, 60641",
"pms_datapull_id": "Rently02|221",
"device_id": "af84cf4a-6051-4653-9f01-0a868d4dd0c9",
"device_name": "lock-8",
"device_type": "lock",
"message_type": "Physical Unlock/Staff Unlock/Staff Code/Vacancy Staff Code/Hub Lock Code/Master Code/Tampered code/Reservation Check-in",
"details": "Himangshu",
"User": "Hand",
"activity_time": 1546862310233
}
Rently Property Unlock:
{
"hub_id": "78bf6b20-9f5f-4564-8cd0-bd0f07ab0ca9",
"home_name": "30011, 5310 West Barry Avenue Common Door",
"serial_no": "30011",
"address": "5310 West Barry Avenue Common Door, Chicago, IL, 60641",
"pms_datapull_id": "Rently02|221",
"device_id": "af84cf4a-6051-4653-9f01-0a868d4dd0c9",
"device_name": "lock-8",
"device_type": "lock",
"message_type": "Rently Property Unlock",
"details": {
"visitor_name": "prospect name",
"visitor_email": "prospect email",
"visitor_phone": "prospect phone"
},
"activity_time": 1546862310233
}