v1

latestOpenAPI 3.0.3Commercial — see Terms2026-07-13274891.4 KB
Webhooks

Create a webhook (Business+)

Register a URL to receive POSTs whenever a policy change matches your filter. Response carries a one-time secret — store it now. Verify with HMAC-SHA256 of the raw body keyed by the secret.

post/api/v1/visa/webhooks

Request body

urlstring uri required
passport_filterISO3[]
destination_filterISO3[]

Example request

{
  "passport_filter": [
    "FRA"
  ],
  "destination_filter": [
    "FRA"
  ]
}

Response

Webhook created.

messagestring

Example response

{
  "webhook": {
    "id": 17,
    "url": "https://your-app.com/orizn-hook",
    "passport_filter": [
      "FRA"
    ],
    "destination_filter": [
      "FRA"
    ],
    "active": true,
    "secret": "whsec_4f2a91c8...e2b1"
  },
  "message": "Webhook created. Store the secret — it won't be shown again."
}