Airalo Developer Platform
  1. Notification
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
      • 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 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. Notification

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 url. It will also include Airalo's signature header which ensures maximum security it was us who send you this HTTP request (check https://partners-doc.airalo.com/#827cb567-db17-484a-a484-5ca10b7fa41b)
Parameters
"type": "async_orders"
"webhook_url": "https://example.com" - in case of notification to be
delivered via your webhook implementation, provide your webhook
implementation url
For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ

Request

Header Params
Accept
string 
required
Example:
application/json
Authorization
string 
required
Example:
Bearer {{token}}
Body Params application/json
type
string 
required
webhook_url
string 
required
Example
{ 
    "type": "async_orders",
    "webhook_url": "https://example.com" 
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/notifications/opt-in' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "type": "async_orders",
    "webhook_url": "https://example.com" 
}'

Responses

🟢200Get the webhook based notification on async orders
text/plain
Body
data
object 
required
notification
object 
required
meta
object 
required
message
string 
required
Example
{
    "data": {
        "notification": {
            "type": "async_orders",
            "contact_point": "https://example.com"
        }
    },
    "meta": {
        "message": "success"
    }
}
Previous
Airalo Webhooks Optin and Flow
Next
Low data notification - opt In
Built with