How Do I Activate Webhooks?

In this article, we take a dive into Webhooks and some examples:

• How does Rhombus use Webhooks
• Validating Webhook Traffic
• How to turn on Webhooks
• Examples

How does Rhombus use Webhooks?

The Rhombus Console provides an array of events to trigger Webhooks. In addition to email, SMS, and push notifications, events generated by Alert Policies can be sent automatically into any app configured to listen to Webhooks POST requests.

Validating Webhook Traffic

1. Validate the SSL certificate presented during the TLS handshake and only allow traffic that presents a Rhombus certificate
2. (In Progress, Q3) HMAC validation. We'll be adding an HMAC signature (hash of webhook body + secret) to webhook requests which you can use to validate that the webhook originated from Rhombus.

How to turn on Webhooks

To turn on the Webhooks, login to the Rhombus web console and go to

1. Settings -> Third Party integrations -> Web-hooks.

2. Click "Edit" and select the switch to enable.

3. Once enabled, you can enter your url in the 'Webhook Url' field. 

The format for the web-hook object is a standard JSON and is structured like,

{
  "version": 2,
  "activityTrigger": optional comma separated string,
  "diagnosticTrigger": optional string
  "summary": string,
  "deviceUuid": string,
  "timestampMs": long,
  "location": string,
  "alertUuid": string,
  "durationSec": optional integer,
  "thumbnailLocation": optional string,
  "clipLocationMap": optional map<string, string>
}

Examples

Example types: 

POLICY_EVENT, CAMERA_STATUS, CLIMATE_STATUS, 
DOOR_STATUS, PROXIMITY_STATUS, UNIDENTIFIED_FACE, UNKNOWN (default)

Examples summaries:

"Hardware Failure Detected: <deviceName> camera at <locationName>"
"Camera Offline: <deviceName> camera at <locationName> is offline"
"<deviceName> camera at <locationName> is now online"
"<deviceName> climate sensor at <locationName> is now online"
"Climate Sensor Offline: <deviceName> climate sensor at <locationName> is offline"
"Climate Sensor Low Battery: <deviceName> climate sensor at <locationName> has a low battery"
"Proximity Sensor Low Battery: <deviceName> proximity sensor at <locationName> has a low battery"
"Alert: <comma separated face names> spotted at <locationName> (<deviceName>)"
"Tamper detected at <locationName> (<deviceName>)"
"Unauthorized badge at <locationName> (<deviceName>)"
"Unidentified Face at <locationName> (<deviceName>)"
"Someone fell at <locationName> (<deviceName>)"
"Unusual behavior at <locationName> (<deviceName>)"
"Human Motion at <locationName> (<deviceName>)"
"Vehicle spotted at <locationName> (<deviceName>)"
"Motion detected at <locationName> (<deviceName>)"
"Asset tag arrived at <locationName> (<deviceName>)"
"Asset tag departed at <locationName> (<deviceName>)"
"Asset tag moved at <locationName> (<deviceName>)"
"Unclassified Activity at <locationName> (<deviceName>)"

If you have any further questions please reach out to our Rhombus Support at help@rhombus.com. If you would like to talk to a Rhombus Sales Representative please reach out to sales@rhombus.com.