Webhook simulator

POST

/v2/simulator/webhook

💡

This endpoint comes with a Rate Limit: 5 requests per minute per unique IP address.

The Webhook Simulator lets you trigger mock webhook events directly to your configured endpoint without placing real orders or consuming credit. Use it during integration to verify your webhook handler, signature verification, and payload parsing for each event type before going live.

The following events are supported:

low_data_notification — simulates a data-usage or expiry alert on an eSIM

credit_limit_notification — simulates a credit balance threshold alert

async_order_notification — simulates the webhook sent after an asynchronous order completes

For more information and best practices visit our FAQ page

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Webhook Simulator

text/plain

🟠422Unsupported Event

🟠400Invalid Webhook URL

🟠400User not opt-in

🟠400Invalid configuration

🔴500Unexpected error

Request Example

Shell

JavaScript

Java

Swift

cURL

Low Data Notification [Example 1]Low Data Notification [Example 2]Low Data Notification [Example 3]Low Data Notification [Example 4]Credit Limit Notification [Example 1]Credit Limit Notification [Example 2]Credit Limit Notification [Example 3]Credit Limit Notification [Example 4]Async Order Notification [Example 1]

curl --location '/v2/simulator/webhook' \
--header 'Authorization: Bearer {{token}}' \
--header 'Accept: application/json' \
--header 'url: https://partners-api.airalo.com' \
--header 'Content-Type: application/json' \
--data '{
    "event": "low_data_notification",
    "type": "expire_1",
    "iccid": "8997212330099025334",
    "webhook_url": "https://example.com"
}'

Response Example

200 - Webhook Simulator

{
    "success": "Notification sent"
}

Modified at 2026-06-04 10:37:09

Opt out

Check balance