Smart Home
  1. Introduction
  2. Smart Home API references
  3. Webhook Notification Integration

Introduction

Smart Home APIs provide capabilities for customers to manage properties, hubs, devices, reservations, codes, schedules, and invitations. In addition, you can set up webhook notifications to invoke a service at your server to receive important alert, activities, and status change in real-time.
The following are a few tips to use our APIs:
    • Before invocation of an API, you need to obtain an access token from Agents API
    • Many APIs need property_id, which you can get by querying Properties API
    • Our APIs use jason format for both input and output parameters.
Agents Access Token API
Use this API to get access token. The token is needed to access other APIs in this document.
Properties APIs
You can query, create, update, and destroy properties. You can also get information about devices attached to a property.
Hubs APIs
You can do following things with Hubs APIs:
    • query a list of hubs, for example, with home name or serial number.
    • get and update hub detail
    • find a list of devices attached to a hub
    • reset the master code if it is exposed. Only user have role “Hub Installer” can access this API.
Devices API
You can query and update device detail, such as assign a device to a property.
Reservations APIs
You can manage reservation, including query, creation, update, and deletion reservations.
Codes APIs
You can manage lock codes via these APIs:
    • create lock code
    • update lock code
    • query lock code and detail
    • delete lock code
Schedules API
You can create, update, and delete schedules. You can find schedules associated with a device and activate schedule for a device.
Hardware Command APIs
You can send command to a hub or a device.
Hub and Device Activity APIs
You can get activities info at a hub or a device.
MQTT
You can get MQTT response from a hub (need to call one of authentication APIs first to get access.)
Invitations APIs

You can create, update, and query invitations. There is also an API to move out a property.

Webhook Notification Integration

Webhook is a popular integration technology used by companies like Github, Amazon, etc. The information is sent in real-time as it is recorded into our database.

To get started, provide YOUR Rently CLIENT SUCCESS MANAGER with a URL ENDPOINT where you want to receive the web post and RENTLY WILL FACILITATE TESTING AND DEPLOYMENT. The content of the post will be in JSON format. The best way to test the API is actually use Hurl.it or Postman tool so that you can post the following examples to your web end points and debug accordingly. PLEASE BE SURE TO DEBUG BEFORE PROVIDING THE URL TO YOUR RENTLY CSM.

Here is an example webhook notification (more examples are given in Webhooks reference).

{
  "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",
  "details": "battery/external",
  "activity_time": 1546862518845
}

Smart Home supports dozens of alert or activity notification events, including events with following devices: hub, lock, thermostat, contact sensor, switch, motion sensor, dimmable switch, garage door, lightbulb, repeater, valve controller, smoke alarm, leakage sensor, door bell, siren, access panel, etc.

 

Suggest Edit