Webhook definition

A webhook is a method in the context of Airalo's API, which serves as a means to seamlessly push real-time data updates to our partner's designated endpoint URL. This functionality ensures timely and efficient data synchronization between our systems and those of our valued partners.

NOTE: Whenever an optin is performed, the webhook_url parameter is checked by the system via HEAD request, to which it must respond with 200 OK to be considered successful

There are three types:
- Credit Limit Notification
- Low Data Notification__- Async Order

Custom Header for Payload Signing

To enhance the security and integrity of transmitted data, our webhook implementation includes a custom header for payload signing which is a HMAC value with sha512 algorithm. Partners are strongly encouraged to include this header in their requests to validate the authenticity and integrity of the payload.

Header name: airalo-signature

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

Responses

🟢200Webhook definition

text/plain

Body

object {0}

Example

// 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

Request

Request samples

Responses

Webhook definition

Custom Header for Payload Signing#

Request

Request samples

Responses

Custom Header for Payload Signing