Skip to Content
OpenRoam Docs
Webhook events

A wallet balance fell to a lower low-balance threshold band.

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
eventId*string
Formatuuid
eventType*string
timestamp*integer
Formatint64
data*
isTest?boolean

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

Response Body

The event was accepted.

Example Requests
POST/partner.balance.low
Request Body
application/json
{  "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",  "eventType": "string",  "timestamp": 0,  "data": {    "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",    "balance": 0,    "lowBalanceThreshold": 0,    "thresholdPercentage": 0,    "currency": "string"  }}
Header Parameters
{  "X-OpenRoam-Webhook-Id": "string",  "X-OpenRoam-Timestamp": "string",  "X-OpenRoam-Event-Id": "string",  "X-OpenRoam-Signature": "string"}