Alerts System Reference
This document provides comprehensive information about the Dashboard.PT alerts system. Learn how to configure, manage, and customize alerts for your graphs and dashboards.
Alerts Overview
The Dashboard.PT alerts system allows you to monitor your data and receive notifications when specific conditions are met. This helps you stay informed about important changes or thresholds in your data without constantly checking your dashboards.
Key Features:
- Configure alerts based on various condition types
- Receive notifications via email, SMS, or webhook
- Set cooldown periods to prevent notification spam
- View alert history and triggered events
- Customize notification content and formats
Alert Types & Conditions
Dashboard.PT supports several types of alert conditions to meet various monitoring needs.
| Condition Type | Description | Use Case |
|---|---|---|
| Above | Triggers when data exceeds a specified value | Resource utilization thresholds, performance targets |
| Below | Triggers when data falls below a specified value | Minimum service levels, stock levels |
| Equal | Triggers when data matches a specific value | Specific state monitoring, event detection |
| Between | Triggers when data is outside an acceptable range | Quality control, operating parameters |
| Percent Change | Triggers when data changes by a certain percentage | Sudden spikes or drops, trend changes |
Condition Timeframes
For certain condition types, you can specify a timeframe to analyze the data over. This allows you to detect trends or sustained conditions rather than responding to momentary spikes.
Examples:
- "Above 90% for 5 consecutive data points"
- "Below 50 units for more than 30 minutes"
- "Changed by more than 20% within 1 hour"
Notification Methods
Dashboard.PT offers multiple notification channels to ensure you receive alerts in the most convenient way.
Email Notifications
Receive detailed alert notifications to your email address. Includes graph previews and action links.
SMS Notifications
Get concise text messages for critical alerts. Available on STANDARD and higher plans.
Webhook Integration
Send alert data to your own systems or third-party services like Slack, Teams, or custom applications.
Notification Limits
Notification methods may be limited based on your subscription plan. See the Pricing page for details.
Creating Alerts
You can create alerts from any graph in your dashboard. Follow these steps to set up a new alert:
-
Navigate to the Graph: Open the dashboard containing the graph you want to monitor.
-
Access Alert Settings: Click the three-dot menu in the top-right corner of the graph, then select "Create Alert".
-
Configure Alert Conditions: Define the condition that will trigger the alert.
{
"name": "High CPU Usage Alert",
"condition_type": "above",
"condition_value": 90,
"condition_timeframe": 5, // Optional: number of data points
"notify_email": true,
"notify_sms": false,
"notify_webhook": false
} -
Set Notification Preferences: Choose how you want to be notified when the alert is triggered.
-
Configure Advanced Options (Optional): Set cooldown periods, custom messages, or other options.
-
Save the Alert: Click "Create Alert" to activate monitoring.
Alerts API
The Alerts API allows you to programmatically manage your alert configurations.
| Endpoint | Method | Description |
|---|---|---|
| /api/alerts | GET | List all alerts |
| /api/alerts | POST | Create a new alert |
| /api/alerts/{id} | GET | Get a specific alert |
| /api/alerts/{id} | PUT | Update an alert |
| /api/alerts/{id} | DELETE | Delete an alert |
| /api/alerts/history | GET | Get alert trigger history |
Create Alert
Request body example:
"graph_id": 123,
"name": "Server CPU Alert",
"condition_type": "above",
"condition_value": 90,
"condition_timeframe": 5,
"notify_email": true,
"notify_sms": false,
"notify_webhook": true,
"webhook_url": "https://example.com/webhook",
"cooldown_minutes": 30
}
Webhook Integration
Webhook notifications allow you to integrate alerts with your own systems or third-party services.
Webhook Payload
When an alert is triggered, Dashboard.PT sends a POST request to your webhook URL with a JSON payload:
"alert_id": 456,
"alert_name": "Server CPU Alert",
"graph_id": 123,
"graph_name": "Server CPU Usage",
"dashboard_id": 789,
"dashboard_name": "Server Monitoring",
"condition_type": "above",
"condition_value": 90,
"triggered_value": 95.2,
"triggered_at": "2023-09-15T14:22:30Z",
"graph_url": "https://dashboard.pt/view-graph.php?id=123"
}
Integration Examples
Dashboard.PT webhooks can be easily integrated with popular services:
- Slack using Incoming Webhooks
- Microsoft Teams via Connectors
- Discord using Webhook URLs
- Custom applications or monitoring systems
Alert History
Dashboard.PT maintains a history of all triggered alerts, allowing you to review past incidents and track patterns.
Viewing Alert History
You can access your alert history from the Alerts section of your dashboard. The history includes:
- When each alert was triggered
- The data value that triggered the alert
- Which notification methods were used
- Whether the notifications were successfully delivered
Alert history is retained according to your subscription plan's data retention policy.
Best Practices
Follow these recommendations to get the most from the Dashboard.PT alerts system:
Set Appropriate Thresholds
Configure thresholds that balance between catching important events and avoiding alert fatigue. Consider normal variations in your data when setting thresholds.
Use Timeframes Wisely
For volatile metrics, use timeframes to ensure alerts are triggered only when conditions persist, not just on momentary spikes or dips.
Set Appropriate Cooldowns
Configure cooldown periods to prevent notification spam during ongoing incidents. Different alert types may need different cooldown settings.
Prioritize Notification Methods
Use email for routine alerts, reserve SMS for critical issues, and leverage webhooks for automated responses or team notifications.
Want to try it? The free plan has no time limit.
Create a free account