Send a test push
Push sample data of an event type to a webhook's URL once, to check your endpoint.
For postpaid SIM service only
403 will be returned if your partner account does not have postpaid SIM service.
The push is like a real one, with test set to true and a sim ICCID of zeros. It is not retried and not recorded as an
event of the webhook.
The call waits for your endpoint to respond, up to 10 seconds. It returns 200 even when your endpoint fails; check
attempt for the result.
Required Capabilities
Webhook Manager
Request
Path parameters
ID of the webhook.
Body parameters
Event type to send sample data of. It must be one of the event types the webhook subscribes to.
POSTPAID_SIM_USAGE_UPDATED— The live usage of one or more postpaid SIMs in your partner account changes
Response
A json is returned in the response body with the following fields:
The request pushed to your endpoint.
Show child attributes
URL the request is sent to.
HTTP method of the request. Always POST.
Headers of the request, with the token masked.
Show child attributes
Name of the header.
Value of the header.
Body of the request, as the JSON-encoded string that is sent.
Result of the push.
Show child attributes
Time of when the attempt is made.
HTTP status your endpoint responded with. null if there was no response.
Headers your endpoint responded with, one item per value.
Show child attributes
Name of the header.
Value of the header.
Body your endpoint responded with, cut to its first 4,096 characters. null if there was no response.
Why there was no response, e.g. a timeout. null if your endpoint responded.
Duration of the attempt, in milliseconds.
Examples
Request
curl -X POST 'https://portal.peplink.com/api/e/v1/cp/webhooks/{id}/test' \ -H 'Authorization: Bearer {token}' \ -H 'Content-Type: application/json' \ --data-raw '{"eventType": "POSTPAID_SIM_USAGE_UPDATED"}'Response
{
"request": {
"url": "https://partner.example.com/peplink/events",
"method": "POST",
"headers": [
{ "key": "Authorization", "value": "Bearer s3cr...6789" },
{ "key": "Content-Type", "value": "application/json" },
{ "key": "User-Agent", "value": "Peplink-Webhook/1.0" }
],
"body": "{\"eventId\":\"6704f2b0c3d4e5f6a7b8c9e1\",\"eventType\":\"POSTPAID_SIM_USAGE_UPDATED\",\"createdAt\":\"2026-10-08T03:15:00.123Z\",\"data\":{\"items\":[{\"iccid\":\"00000000000000000000\",\"year\":2026,\"month\":10,\"usageMb\":123.45,\"lastEventAt\":\"2026-10-08T03:15:00.123Z\"}]},\"test\":true}"
},
"attempt": {
"attemptedAt": "2026-10-08T03:15:00.130Z",
"responseStatus": 200,
"responseHeaders": [{ "key": "content-type", "value": "application/json" }],
"responseBody": "{\"ok\":true}",
"error": null,
"durationMs": 184
}
}