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

Webhooks guide

What are webhooks?#

Webhooks are automated messages sent from one application to another in response to specific events. Unlike traditional APIs where you need to regularly request information ("polling"), webhooks deliver data to you the moment something happens. They're essentially user-defined HTTP callbacks - a way for an app to provide other applications with real-time information.
Think of webhooks as a "phone call" rather than "checking your mailbox" - instead of repeatedly asking if anything new has happened, you get notified immediately when it does.

How webhooks work#

The basic webhook flow follows these steps:
1.
Registration: A receiving application provides a URL (webhook endpoint) to the sending application
2.
Verification: The sending application validates that the URL is accessible and properly configured
3.
Event detection: When a relevant event occurs in the sending application
4.
Notification: The sending application sends an HTTP POST request with event data to the registered URL
5.
Processing: The receiving application processes the data and responds with a success status

Why use webhooks?#

Efficiency and real-time updates#

Webhooks eliminate the need for constant polling, which saves resources and reduces latency. Instead of checking every few minutes whether something has changed, you receive updates instantaneously when they occur.

Webhook Airalo use cases#

Webhooks enable seamless integration between your systems and ours, allowing them to communicate and respond to events automatically without manual intervention. For eSIMs, this is particularly valuable, as it ensures you can act in real time to support your users. We currently support the following use cases:
Async orders triggered when your order is successfully completed, including the successful generation of an eSIM.
Low data triggered when your users’ eSIMs are running low on data or nearing expiry, so you can notify them and encourage timely top-ups.
Credit limit triggered when you are approaching your credit limit for purchasing eSIMs, enabling you to take proactive action with your account manager.

Scalability#

As applications grow, the efficiency benefits of webhooks become even more significant:
Reduced server load: The sending application only needs to make HTTP requests when actual events occur
Less network traffic: No need for frequent polling requests that return "no changes"
Better user experience: End users see updates faster without manual refreshing

Implementing webhooks effectively#

To create a robust webhook system, consider these best practices:
1.
Verification: Always verify webhook endpoints are valid before saving
2.
Retry logic: Implement a retry mechanism for failed deliveries
3.
Security: Use HTTPS, implement authentication methods, and validate webhook sources
4.
Idempotency: Ensure multiple deliveries of the same webhook don't cause duplicate processing
5.
Monitoring: Track webhook delivery success rates and response times

Challenges and solutions#

Despite their benefits, webhooks come with challenges:
Reliability: Network issues can cause missed webhooks (solution: implement retry logic)
Security: Webhook endpoints can be vulnerable to attacks (solution: validate sources and use authentication)
Debugging: Webhook issues can be difficult to troubleshoot (solution: comprehensive logging and monitoring)
Overloading: Too many webhooks can overwhelm receiving systems (solution: rate limiting and queuing)
Modified at 2025-08-22 09:15:04
Previous
Airalo webhooks opt-in and flow
Next
Webhook definition
Built with