Skip to main content

Create a new webhook subscription

POST 
/v1/Webhooks

Creates webhook subscription for real-time event notifications.

Available Events:

  • client.onboarding.poa_signed - Client signed Power of Attorney
  • client.onboarding.contract_signed - Client signed Service Delivery Agreement
  • client.linked - Client successfully linked to your account
  • client.link_declined - Client declined to link
  • client.link_requested - 409 link request created (awaiting end-user approval)
  • client.link_expired - 409 link request reached its TTL without approval/decline
  • case.created - Collection case created for linked client
  • case.updated - Collection case lifecycle changed (e.g., Active → Closed)
  • case.closed - Collection case closed (terminal state)

Security: Response includes Base64-encoded signing secret (shown only once). Store it to verify HMAC-SHA256 signatures on deliveries.

Requirements: HTTPS URL required (HTTP, localhost, and private IPs rejected). Deliveries retry with exponential backoff (8 attempts). Webhook auto-disables after max failures.

Request​

Responses​

Webhook created successfully