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.
X-OpenRoam-Webhook-Id*stringThe id of the webhook subscription that delivers the event.
X-OpenRoam-Timestamp*stringWhen this delivery attempt was signed, in Unix seconds.
X-OpenRoam-Event-Id*stringThe event's unique id, the same as eventId in the body. Deduplicate on it.
X-OpenRoam-Signature*stringLowercase hex HMAC-SHA256 of {timestamp}.{eventId}.{raw body}, keyed with your webhook secret.
application/json- body
eventId*stringFormat
uuideventType*stringtimestamp*integerFormat
int64data*isTest?booleanTrue for a synthetic test delivery. Omitted on live events.
The event was accepted.
Example Requests
POST/partner.balance.low
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" }}{ "X-OpenRoam-Webhook-Id": "string", "X-OpenRoam-Timestamp": "string", "X-OpenRoam-Event-Id": "string", "X-OpenRoam-Signature": "string"}