Webhook Configuration
Configure webhooks via POST /webhooks or PATCH /webhooks/:id.
What is webhook config
Webhook configuration defines where and how domain events are delivered. Create a webhook via POST /webhooks or update via PATCH /webhooks/:id. Each webhook is scoped to a tenant and environment. When an event occurs (e.g. match created), the system POSTs the payload to your URL.
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | Yes | Endpoint URL for event delivery |
| secret | string | No | HMAC secret for signature verification |
| subscribedEvents | string[] | Yes | Event types to receive |
| retryPolicy | object | No | maxAttempts, backoffStrategy, backoffIntervals |
| headers | object | No | Custom headers to send |
| timeout | number | No | Request timeout in ms |
Signature verification
When you provide a secret, the system signs each payload with HMAC-SHA256 and sends the signature in a header (e.g. X-Webhook-Signature). Verify the signature on your side to ensure the request came from Payment Reconciler and was not tampered with. See Webhooks for the verification approach.
Subscribed events
Examples: INCOMING_TRANSACTION_CREATED, MATCH_CREATED, MATCH_ACCEPTED, MATCH_REJECTED, DATA_SOURCE_SYNC_COMPLETED. Subscribe only to events you need.
Retry policy
Configure retryPolicy with maxAttempts and backoffIntervals (array of ms, e.g. [60000, 300000, 900000]) or backoffStrategy (e.g. exponential). The system retries according to this policy before marking the delivery as failed.
Related
- Webhooks — Conceptual overview
- Webhooks API — Create, update, list