How Do I Activate Webhooks? – Rhombus Support

Topics included in this article:

How does Rhombus use Webhooks
Validating Webhook Traffic
How to turn on Webhooks
Examples
Helpful Links
Contact Support or Sales

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.

At Rhombus, we run all of our services as highly-available across geographic regions. Part of this infrastructure includes automatically reacting to failures/changes as they occur, including the IP addresses used for outbound traffic (webhooks). So while we'd be happy to provide you the IP addresses that are currently used, they are almost guaranteed to change on a regular basis, almost always without our involvement.

Validating Webhook Traffic

We typically recommend a couple of options for validating/securing webhook traffic originating from Rhombus:

Validate the SSL certificate presented during the TLS handshake and only allow traffic that presents a Rhombus certificate
(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 -> Webhooks

Screen_Shot_2020-02-26_at_2.27.54_PM.png

2. Click the toggle option

3. Once enabled, you can add a webhook Url into "New Webhook Url" section.

4. Select a trigger type "Diagnostic" or "Activity"

Note: Diagnostic event relates to events like camera disconnection or camera reconnection. Activity events are related to any AI triggered event like human or vehicle movement.

5. Click add Webhook and you are set up!

Examples

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>
}

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>)"

Helpful Links

Contact Support or Sales

Have more questions? Contact Rhombus Support at +1 (877) 746-6797 option 2 or support@rhombus.com.

Interested in learning more? Contact Rhombus Sales at +1 (877) 746-6797 option 1 or sales@rhombus.com.