Skip to Content
OpenRoam Docs
Webhook events

The profile status of an eSIM changed.

Delivered at least once to your webhook URL.

Delivered at least once to your webhook URL. Acknowledge with any 2xx response. A signed body with isTest: true contains synthetic data and should be handled as a connectivity check.

Header Parameters

X-OpenRoam-Webhook-Id*string

The id of the webhook subscription that delivers the event.

X-OpenRoam-Timestamp*string

When this delivery attempt was signed, in Unix seconds.

X-OpenRoam-Event-Id*string

The event's unique id, the same as eventId in the body. Deduplicate on it.

X-OpenRoam-Signature*string

Lowercase hex HMAC-SHA256 of {timestamp}.{eventId}.{raw body}, keyed with your webhook secret.

Request Body

application/json
  1. body

The esim.profileStatus.updated webhook body.

eventId*string

The event's unique id, the same as the X-OpenRoam-Event-Id header. Deduplicate on it.

Formatuuid
eventType*string

Always esim.profileStatus.updated.

timestamp*integer

When the event was created, in Unix seconds (whole seconds since 1970-01-01T00:00:00Z).

Formatint64
data*

The eSIM and its new profile status.

isTest?boolean

True for a synthetic test delivery. Omitted on live events.

Response Body

The event was accepted.

Example Requests
POST/esim.profileStatus.updated

The esim.profileStatus.updated webhook body.

Request Body
application/json
{  "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",  "eventType": "string",  "timestamp": 0,  "data": {    "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",    "orderItemId": "33207bce-c741-4896-a76b-8afcf6e4179a",    "profileStatus": "empty"  }}
Header Parameters
{  "X-OpenRoam-Webhook-Id": "string",  "X-OpenRoam-Timestamp": "string",  "X-OpenRoam-Event-Id": "string",  "X-OpenRoam-Signature": "string"}

Search flights POST

Searches flight itineraries and the fares bookable on them. Send one slice per flight (one for one-way, two for a return, more for a multi-city trip) and every passenger; at least one passenger must be an `adult`, and children and infants need an `age`. Optional `filters`: `maxStops`, `preferredAirlines` and `excludedAirlines` select itineraries; `refundableOnly` and `maxPrice` select fares, and an itinerary left without a fare is not returned. The body rejects an unknown field at every level, and the route takes no query parameters. Returns `{ items, pagination }`. Each item is one itinerary, the same flights sold by the same airline, with its fares as `offers`, cheapest first; items are ordered by their cheapest fare, then total duration. `page` and `limit` (defaults 1 and 10, `limit` at most 100) page through itineraries, and `pagination.totalCount` counts them. Each page runs a new airline search, so fares can change between pages. An item's `id` is valid only within this response and cannot be ordered; quote and order an offer's `publicId` before its `details.expiresAt`. Prices are for all passengers, in `currency` or the API key's currency, and are indicative. Errors: an invalid or unknown field, or a query parameter, 400 / 10001; an unsupported `currency` 404 / 10004.

esim.usage.updated

Delivered at least once to your webhook URL. Acknowledge with any `2xx` response. A signed body with `isTest: true` contains synthetic data and should be handled as a connectivity check.