Track Postpaid SIM Live Usage with Webhooks

Use this recipe to get the data usage of your postpaid SIMs in near real time. With this data, your systems can notify a customer, throttle a SIM or suspend a SIM before the SIM uses more data than its allowance.

When the usage of your SIMs changes, Peplink sends a POSTPAID_SIM_USAGE_UPDATED event to your endpoint. The event gives the usage of each changed SIM from the start of the month. Keep the latest value for each SIM. You do not have to request the usage again and again.

Recipe: Prepare Your EndpointCopy Anchor Link

Your endpoint receives each event as a POST request. The request body is JSON, as in this example:

{
  "eventId": "66fd0c1e8a1b2c3d4e5f6a7b",
  "eventType": "POSTPAID_SIM_USAGE_UPDATED",
  "createdAt": "2026-10-02T01:20:00.000Z",
  "data": {
    "items": [
      {
        "iccid": "89000000000000000000",
        "year": 2026,
        "month": 10,
        "usageMb": 886.94,
        "lastEventAt": "2026-10-02T01:18:41.000Z"
      }
    ]
  },
  "test": false
}

Make sure that your endpoint does these tasks:

• It uses https and a public internet address. Peplink does not follow redirects.
• It accepts a request only when the Authorization header is Bearer <token>. <token> is the token of the webhook.
• It sends a 2xx response in 10 seconds or less.
• It ignores an event when it processed the same eventId before. A retried event has the same eventId.
• For each iccid, year and month, it keeps only the item with the latest lastEventAt. Events can arrive in a different order.
• It ignores an event when test is true. A test event contains sample data.

For a description of each field, see Webhooks Overview.

Recipe: Set Up a Webhook via Portal UICopy Anchor Link

Step 1: Grant Webhook CapabilitiesCopy Anchor Link

If your systems use the webhook APIs, give the API key the same capability.

Step 2: Create the WebhookCopy Anchor Link

Peplink starts to send events when you create the webhook. Your account can have a maximum of 10 webhooks.

To use the API, see create a webhook.

Step 3: Test the WebhookCopy Anchor Link

To use the API, see send a test push.

Step 4: Monitor the EventsCopy Anchor Link

The Details tab of the webhook shows a summary of its events. The Events tab shows each event with its status and last attempt. You can filter the events by status.

If a request fails, Peplink sends it again, with a maximum of 3 attempts. After 3 failed attempts, the status of the event changes to Failed. To send a failed event again, open the event and click Redeliver. To recover many events, see Recover Missed Events.

To use the API, see search events, retrieve an event and redeliver an event.

Recipe: Recover Missed EventsCopy Anchor Link

Use this procedure when your endpoint did not receive events, for example during an outage. Peplink keeps each event and the data that it sent. Your systems read the events with the API. Peplink does not send the events again, and your endpoint does not have to be available.

You need an API key with the Webhook Viewer capability.

GET /webhooks/{id}/events/search?pageNum=1&pageSize=100&createdAtRange=2026-10-07T17:00:00Z,

{
  "id": "6704f3c1d2e3f4a5b6c7d8e2",
  "eventType": "POSTPAID_SIM_USAGE_UPDATED",
  "data": "{\"items\":[{\"iccid\":\"89000000000000000003\",\"year\":2026,\"month\":10,\"usageMb\":9891.84,\"lastEventAt\":\"2026-10-07T17:03:21.000Z\"}]}",
  "status": "FAILED",
  "createdAt": "2026-10-07T17:04:00.000Z"
}

To send a small number of events again, use Redeliver in the portal. See Step 4: Monitor the Events. To use the API, see redeliver an event.

Recipe: Check SIM Live Usage via Portal UICopy Anchor Link

Use this tab to check the usage of one SIM, for example when a customer asks about it. To use the API, see get live usage of a SIM.