Skip to main content
How do I set Usage Alerts?

Usage alerts give you the ability to keep tabs on the usage of individual SIMs.

Jakub Kubinski avatar
Written by Jakub Kubinski
Updated over 2 months ago

Each SIM in our system has a usage limit at which the given SIM will be blocked from using any more data for the given period. This limit is set in bytes and mandatory for all SIMs. The default value is: 10GB per month.

Optionally, an alert threshold can be set.
โ€‹

Hitting the alert threshold or usage limit will send out a notification via Webhooks if an appropriate Webhook has been set up. You can see how to set up a Webhook here.
โ€‹
Here's an example of what the event will look like:

{
"type": "usage-alert",
"reason": "alert-threshold",
"time": "2021-12-01T10:08:36.530Z",
"sim_id": "000000001",
"iccid": "89457387300000000105",
"ipv4": "100.96.0.1",
"data_limit": {
"used": 1101976,
"total": 2000000,
"type": "monthly",
"period": "202112",
"alert_threshold": 1000000,
"resets_at": "2022-01-01T00:00:00.000Z"
},
"sim_label": "foobar"
}

The "reason" field will either contain the string "blocked" or "alert-threshold" depending on if it was the usage limit that was reached or the alert threshold respectively.


The data limit parameters can be seen in the sidebar on the SIM page, and can be edited by clicking the 'edit' icon.

If you have any more questions about usage limits, you are welcome to reach out at [email protected].

Did this answer your question?