Opt in

POST

/v2/notifications/opt-in

INFO

Email notifications for Async orders are not supported.

This feature allows you to subscribe to Async orders notifications. 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.
NOTE: The endpoint must support HEAD and POST HTTP methods.

The response will include the contact_point field, which reflects webhook URL you provided when opting in to the webhook.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Get the webhook based notification on async orders

text/plain

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/notifications/opt-in' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'url: https://partners-api.airalo.com' \
--header 'Content-Type: application/json' \
--data '{ 
    "type": "async_orders",
    "webhook_url": "https://example.com" 
}'

Response Example

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

Modified at 2025-12-19 15:41:44

Opt out

Get notification details