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

Airalo Webhooks Optin and Flow

Visual represntation of Airalo's /v2/notifications/opt-in endpoint flow#

setup.png
Note: you can review the possible opt-in requests here: https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/notification-2508831f0

Visual represntation of Airalo's webhook notification flow#

webhooks.png

Webhook Server Code snippets#

Please use the following as pseudo code only to help you get the starting idea on how to implement your own webserver. They are not production ready solutions.
Please check again how to handle the airalo-signature header and the benefits of using it in your flow: https://www.apidog.com/apidoc/shared/e776ed42-a7e7-4c52-9ea2-b65d4758fea2/webhook-definition-11883043e0

PHP (async order example)#

Python (async order example)#

Nodejs (async order example)#

Modified at 2025-04-08 13:22:55
Previous
Understanding Webhooks: Asynchronous Communication for Modern Applications
Next
Async orders
Built with