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 Example

Shell

JavaScript

Java

Swift

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" 
}'

Response Example

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

Request

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{token}}

Body Params application/json

type

string

required

webhook_url

string

required

Examples

Responses

🟢200Get the webhook based notification on async orders

text/plain

Body

data

object

required

notification

object

required