Data Alerts

Data Alerts notify you when your building data goes quiet, so you don't have to keep checking dashboards to confirm everything is still flowing. Choose buildings or equipment, set the stale data percentage threshold, and add the people who should hear about it. Onboard emails them when the alert triggers, and again once things are back to normal.

🔔 Setting Up a Data Alert

Any Onboard user can set-up a data alert:

Open the Explorer page in the Onboard portal.
Go to the Buildings tab or the Equipment tab, depending on what you want to monitor.
Select buildings or equipment.
Click Create Alert.
Set the alert parameters. See Alert Settings below.
Add recipients. You can add your own email or a teammate's, so the right people hear about it when a feed goes quiet.
Click Submit.

⚙️ Alert Settings

Each alert has the following settings:

Setting	What it does
Threshold (%)	The percentage of points in the selected building or equipment that must be stale for the alert to trigger. The alert triggers when this percentage is reached or exceeded.
Initial Interval	How long after points go stale before the first alert email is sent.
Re-alert Interval	How long to wait before sending a second alert email if the alert is still active.
Clear Interval	How long after the alert is resolved before a clear email is sent.

The default and minimum for each interval is 60 minutes.

📧 Notifications

Alerts trigger when the percentage of stale points in the selected building or equipment reaches or exceeds the threshold you set, and stays there for the Initial Interval. A point is stale when Onboard has not received a recent update from it.

Data Alerts are sent by email only.

Alert email: Sent after the Initial Interval once the threshold is reached.
Second alert: Sent after the Re-alert Interval if the alert is still active.
Clear email: Sent after the Clear Interval once the alert is resolved, so you know things are back to normal.

📡 Get Notified When a Deployment Goes Offline

To be notified when a deployment goes offline or stops collecting data, select the building associated with the deployment when you create the alert. The alert then covers all the live points in that building. Set the threshold to 100%.

Any time the building drops to 0 live points, whether the Collector went offline or another fault occurred, you will be notified by the alert.

📋 Managing Alerts

The Data Alerts page lists your alerts along with their current status. Open it from the navigation menu on the Onboard portal. Org Admins and Org Managers can see all alerts created by any user in their organization. Org Viewers can see only the alerts they created.

OKAY	...the alert condition is not met and alert is not active.
ALERT	...the alert has triggered and is active.
RECOVERING	...the issue has cleared and the alert is waiting out its Clear Interval. The status stays RECOVERING for as long as any alert is waiting for the clear interval to pass.

When managing an alert, you can:

Change the threshold and the Initial, Re-alert, and Clear intervals
Add or remove recipient email addresses
Activate, deactivate, or delete an alert

You cannot change the building or equipment an alert monitors. If your monitoring needs change, create a new alert instead.

Using the API

API users can also create and manage alerts programmatically. The Data Alerts endpoints are listed under the buildings:monitor scope.

💡 Note

A Data Alert tells you that data has gone quiet. It does not fix the cause. When you receive an alert, see Dealing with Offline Data to investigate the root cause and restore data collection.