Buvei
API ReferenceWebhook Events

ESIM_USAGE_ALERT

An eSIM crossed a data-usage threshold — nudge your user to recharge.

Delivered when an eSIM's data usage crosses a threshold (e.g. 50% / 90% of the plan allowance). This is the natural trigger to prompt your user to recharge before they run out.

Headers

Standard webhook headers — see Webhook security.

Payload

eventIdstring
eventTypestring
Always "ESIM_USAGE_ALERT".
timestampinteger
Epoch milliseconds.
dataobject
Response
{
  "eventId": "e_ICSKeSEvgjmjp91NoJLs",
  "eventType": "ESIM_USAGE_ALERT",
  "timestamp": 1783938976776,
  "data": {
    "esimNo": "esim_6ba300976dbb48b8a1",
    "iccid": "8948010010043989416",
    "thresholdPercentage": 50,
    "dataTotalMb": 1505,
    "dataUsedMb": 753,
    "dataLeftMb": 752
  }
}

On this page

Headers
Payload