Async orders

POST

/v2/notifications/opt-in

This feature allows you to subscribe to notifications regarding async orders. 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

For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ

Request

Header Params

Body Params application/json

Example

{ 
    "type": "async_orders",
    "webhook_url": "https://example.com" 
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200Get the webhook based notification on async orders

text/plain

Body

Example

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

Modified at 2024-12-17 16:55:42

Understanding webhooks: Asynchronous communication for modern applications

Low data notification - opt In