Usage Alerts API
4 min
Overview
The Usage Alerts API allows you to receive automated notifications when SIM usage reaches defined thresholds.
Alerts are generated based on:
- SIM-level warning and cut-off limits
- Group-level warning thresholds
- Contract expiry conditions (where applicable)
This enables proactive monitoring and integration with your own systems without requiring continuous polling of usage endpoints.
What This Section Covers
This section explains how to:
- Enable automated usage alert notifications
- Receive alert data via HTTPS POST
- Interpret alert payloads
- Integrate alerts into your own monitoring or operational workflows
How Usage Alerts Work
When a configured threshold is reached:
- The platform generates an alert event
- The alert is queued
- The alert is delivered to your configured endpoint
Alerts can be delivered via:
- Email (configured in the portal)
- API / HTTPS POST (described in this section)
Alert Types
Alerts may relate to:
- SIM-level usage warning threshold
- SIM-level cut-off threshold
- Group-level forecast usage thresholds
- Group-level forecast charge thresholds
- Contract expiry events
Specific alert payload structures are detailed in the following pages.
Design Considerations
- Alerts are event-driven, not polled
- Delivery may be asynchronous
- Your endpoint should be capable of handling duplicate notifications
- Threshold configuration is managed via the portal or API