Webhooks and Requests

Overview

View as Markdown

This section covers server-to-server communication where BRIJ calls your endpoints. There are two types of outbound calls: webhooks and requests.

Webhooks vs Requests

AspectWebhooksRequests
PurposeInformational notificationsData retrieval
Response neededAny 2xx status codeSpecific data in the response body
Retry behaviorBRIJ retries on non-2xx responsesSingle attempt, no automatic retries
Partner actionOptional — process as neededRequired — must return requested data
ExampleOrder status changed, KYC completedQuote request, order creation confirmation

Webhooks

Webhooks are one-way notifications that inform your system about events. When BRIJ sends a webhook:

  • Your server only needs to return a valid 2xx HTTP status code
  • You may optionally perform actions based on the webhook (update your database, trigger workflows, etc.)
  • If your server returns a non-2xx response, BRIJ will retry the webhook multiple times

Requests

Requests are two-way interactions where BRIJ needs specific data from your system. When BRIJ sends a request:

  • Your server must return a response with the requested data in a specific format
  • BRIJ issues each request only once — there are no automatic retries
  • These are typically used when BRIJ needs real-time information (e.g., a quote for an order, confirmation to proceed)

Authentication

All webhooks and requests from BRIJ include a cryptographic signature in the X-BRIJ-Signature HTTP header. You should verify this signature to ensure the request:

  • Originated from BRIJ
  • Has not been tampered with in transit
  • Is not a replay of a previous request

See Signature Verification for detailed implementation instructions and code examples.

Available Webhooks

WebhookDescription
Data Shared by CustomerSent when a customer shares data or attestations with you

Available Requests

RequestDescription
Quote RequestGet a quote for a crypto transaction
Redirect Order RequestCreate an order and get a redirect URL (Tier 1 partners)
Create Order RequestCreate an order in full integration mode
Cancel Order RequestCancel an existing order