Airalo Developer Platform
  1. Endpoints
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • 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
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: 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
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Balance
        • Get balance
      • Request access token
        POST
      • Get packages
        GET
      • Get compatible device list
        GET
      • Future Orders
        POST
      • eSIM voucher
        POST
      • Get eSIM
        GET
      • Cancel future orders
        POST
      • Submit order
        POST
      • Refund Request
        POST
      • Get installation instructions
        GET
      • Submit order async
        POST
      • Get usage (data, text & voice)
        GET
      • Submit top-up order
        POST
      • Update eSIM brand
        PUT
    • Guides
      • Step #1 - Authentication
    • 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
    • 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
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Endpoints

Notification

Understanding Webhooks: Asynchronous Communication for Modern Applications
What Are Webhooks? Webhooks are automated messages sent from one application to another in response to specific events. Unlike traditional APIs where ...
Airalo Webhooks Optin and Flow
Visual represntation of Airalo's /v2/notifications/opt-in endpoint flow :::info[]Note: you can review the possible opt-in requests here: https://...
Async orders
POST/v2/notifications/opt-in
This feature allows you to subscribe to notifications regarding async orders. You will receive the order's data payload on your specified webhook ...
Low data notification - opt In
POST/v2/notifications/opt-in
This feature allows you to subscribe to notifications regarding low data usage. Alerts will be sent when your data usage reaches 75% and 90%. Addition...
Low data notification - opt out
POST/v2/notifications/opt-out
This feature allows you to opt out of notifications regarding low data usage depending upon the type passed in the request payload For more informatio...
Get low data notification
GET/v2/notifications/opt-in
This endpoint allows you to retrieve the details of low data notification from the Airalo Partners API. The access token, obtained from the "Requ...
Credit limit notification
POST/v2/notifications/opt-in
Receive notifications regarding your credit limit as it reaches specific thresholds. You havethe flexibility to opt-in for various levels based on you...
Webhook definition
POST/
A webhook is a method in the context of Airalo's API, which serves as a means to seamlessly push real-time data updates to our partner's desig...
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 test...
Previous
Get eSIM package history
Next
Understanding Webhooks: Asynchronous Communication for Modern Applications
Built with