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 ensures timely and efficient data synchronization between our systems and yours.

Important: Whenever you perform an opt-in, the webhook_url parameter is checked by the system via a HEAD request. Your endpoint must respond with 200 OK for the opt-in to be considered successful.

We currently support three types of webhooks:
- Async Order
- Low Data Notification
- Credit Limit Notification

Custom header for payload signing

To enhance the security and integrity of the transmitted data, our webhook implementation includes a custom header for payload signing. This is an HMAC value generated with the SHA-512 algorithm. You are strongly encouraged to validate this header in your requests to ensure the authenticity and integrity of the payload.

Header name: airalo-signature

Examples on how to verify the integrity of the received webhook event:

Response examples

Below are response examples for an HTTP 200 request:



// Credit Limit Notification Example
{
   "message": "Surpassed 80% of the credit limit balance",
   "remaining": 225.35
}


// Low Data Notification Example
{
   "level": "3days", // possible values "1days", "3days", "75%", "90%"
   "package_name": "bonbon-7gb-10days",
   "remaining_percentage": 43,
   "iccid": "87123123456889019"
}

Custom header for payload signing#

Response examples#

Custom header for payload signing

Response examples