Activating Webhooks in the Rhombus Console

Topics included in this article:

• Overview
• Validating Webhook Traffic
• Enable Webhooks
• Examples
• Helpful Links
• Contact Support or Sales

Overview

The Rhombus Console provides an array of events that can trigger Webhooks. In addition to email, SMS, and push notifications, events generated by alert policies can be automatically sent to 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.

Enable Webhooks

1. To enable Webhooks, log in to the Rhombus Console, navigate to "Settings" and click "Third Party Integrations."

2. Scroll down to the bottom of the page, click the "Webhooks" dropdown menu and click "Webhooks."

3. Click the toggle to enable the integration.

4. Once enabled, a webhook Url can be added into the "New Webhook Url" field.

5. Select either "Diagnostic" or "Activity" as the trigger type.

Note: Diagnostic events relate to events such as a camera disconnection. Activity events are related to any AI triggered event like human or vehicle movement.

6. Click "Add Webhook."

Examples

The format for the webhook object is a standard JSON and is structured as follows:

{
  "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:

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

• Creating and Assigning Alert Policies
• Logs & Reports
• Omnilert Integration

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.