Using Our APIs
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