Airalo Developer Platform
  1. Endpoints
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • 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
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Place order
        • Submit order
        • Submit order async
        • Future orders
        • eSIM voucher
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Place top up order
        • Submit top-up order
        • Get top-up package list
        • Get eSIMs list
        • Get eSIM package history
      • Manage orders & eSIMs
        • Get order list
        • Cancel future orders
        • Get order
        • Update eSIM brand
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
      • Notifications
        • Airalo webhooks opt-in and flow
        • Webhooks guide
        • Webhook definition
        • Notification: Low data
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Credit limit
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Async orders
          • Opt in
          • Get notification details
          • Opt out
        • Webhook simulator
      • Check balance
        • Get balance
      • Refunds
        • Request refund
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Guides
      • How to install the Airalo Plugin for WooCommerce
      • How to set up prices in WooCommerce
      • How to customize the "My eSIMs" page colors in WooCommerce
      • How to convert prices into your local currency
      • How to finalize your WooCommerce shop setup
      • How to test in sandbox mode
      • How to go live
      • How to customize WooCommerce email templates for eSIM sales
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Endpoints

Notifications

Airalo webhooks opt-in and flow
Visual representation of Airalo's /v2/notifications/opt-in endpoint flow :::info[]Note: you can review the possible opt-in requests here.::: Visu...
Webhooks guide
What are webhooks? Webhooks are automated messages sent from one application to another in response to specific events. Unlike traditional APIs where ...
Webhook definition
A webhook is a method in the context of Airalo’s API that allows us to seamlessly push real-time data updates to your designated endpoint URL. This en...
Notification: Low data
Notification: Credit limit
Notification: Async orders
Webhook simulator
POST/v2/simulator/webhook
With this endpoint, you can trigger a Low data notification webhook event with mock data to your opted-in webhook URL. This is useful during the testi...
Previous
Get compatible device lite list
Next
Airalo webhooks opt-in and flow
Built with