Airalo Developer Platform
  1. Notification
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Partner with Airalo
    • Attribute descriptions
    • FAQ
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Guides
      • Step #1 - Authentication
    • Quick start
      • Request access token
      • Get packages
      • Submit order
      • Get installation instructions
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
        • Get top-up package list
        • Get eSIM package history
      • Notification
        • Understanding Webhooks: Asynchronous Communication for Modern Applications
        • Airalo Webhooks Optin and Flow
        • Async orders
          POST
        • Low data notification - opt In
          POST
        • Low data notification - opt out
          POST
        • Get low data notification
          GET
        • Credit limit notification
          POST
        • Webhook definition
          POST
        • Webhook simulator
          POST
      • Balance
        • Get balance
      • Request access token
        POST
      • Get compatible device list
        GET
      • Get packages
        GET
      • Submit order
        POST
      • Submit order async
        POST
      • Submit top-up order
        POST
      • Get eSIM
        GET
      • Get data usage
        GET
      • Get installation instructions
        GET
      • Update eSIM brand
        PUT
      • eSIM voucher
        POST
      • Refund Request
        POST
      • Future Orders
        POST
      • Cancel future orders
        POST
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
        • Get Order
        • Submit Order
        • Submit Top-up Order
      • eSIMs
        • Get eSIMs List
        • Get eSIM
        • Get Installation instructions
        • Get Data Usage
        • Get Top-up Package List
        • Get eSIM Package History
      • Order Statuses
        • Get Order Statuses List
        • Get Order Status Name
      • Packages
        • Get Packages
      • Compatible Devices
        • Get Compatible Device List
      • Notification
        • Low Data Notification
        • Credit Limit Notification
        • Webhook Definition
        • Webhook Simulator
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • TO DELETE Installation plugin backup
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY INTEGRATION
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Notification

Webhook simulator

POST
/v2/simulator/webhook
With this endpoint parthers can trigger a Low Data Notification webhook event with mock data to their opted-in wehbook url. This is useful during testing/integration phase where developers can test their server when receiving such events.
Parameters
"event" - string required
"type" - string required
"iccid" - string optional
For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/simulator/webhook' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": "low_data_notification",
    "type": "expire_1",
    "iccid": "8997212330099025334"
}'
Response Response Example
{
  "success": "Notification sent"
}

Request

Header Params
Authorization
string 
required
Example:
Bearer {{token}}
Body Params application/json
event
string 
required
type
string 
required
iccid
string 
required
Examples

Responses

🟢200Webhook Simulator
text/plain
Body
success
string 
required
Modified at 2024-12-17 16:59:53
Previous
Webhook definition
Next
Balance
Built with