Skip to main content

Webhooks Overview

Webhooks are used to asynchronously notify your system about events such as onboarding progress, pending requirements, or entitlement status changes. This allows you to react to updates without the need for constant polling.

General Information​

  • Protocol: HTTPS POST requests sent to your registered URL.
  • Security: Payloads are signed using the Ed25519 algorithm. You must verify the signature to ensure authenticity.
  • Retry Policy: If your server returns a non-200 status (e.g., 5xx), the system will retry delivery with exponential backoff.
  • Idempotency: Each event has a unique id and timestamp. Always return HTTP 200 OK to acknowledge receipt.