Low data notification - opt In - Airalo Developer Platform

This feature allows you to subscribe to notifications regarding low data usage. Alerts will be sent when your data usage reaches 75% and 90%. Additionally, notifications will be sent when there are 3 days and 1 day remaining before expiration. Notification is available via webhook or email. However, please note that this feature is designed to deliver notifications exclusively to partner email addresses and not directly to customers. Ensure that only a single email address (such as support or back office) is configured for this purpose

type (required)

"webhook_low_data": use this value to receive notification via webhook.

"email_low_data": use this value to receive notification via email.

If type provided is "webhook_low_data":

webhook_url (required): provide the URL of your Webhook implementation. Example: "https://example.com".

If type provided is "email_low_data":

email (required): provide the email address to recieve the email notifications .

language(optional): language for the email based notifications. Example: “en”.

For more information and best practices, visit our FAQ page.

You can also provide your email address using the email parameter, which will send an email to your inbox asynchronously.
Below is a sample of the email notification.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Get the webhook based notification on low data

text/plain

Body

Example

{
    "data": {
        "notification": {
            "type": "webhook_low_data",
            "contact_point": "https://example.com"
        }
    },
    "meta": {
        "message": "success"
    }
}

🟢200Get the email-based notification on low data