Sign in

v1

latestOpenAPI 3.0.42026-08-042281222.0 KB
Webhooks

Create a new webhook subscription

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)
  • cases.replay_failed - A stored case payload failed to create during 409 carry-through (retry via the Customer API)

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.

post/v1/Webhooks

Request body

urlstring uri required

The HTTPS URL where webhook events will be delivered. Must be a valid HTTPS URL.

eventsstring[] required

Array of event types to subscribe to.

isTestModeboolean

When true, the subscription is created with DataClassification.Test, meaning it will only receive events for test-classified data. Defaults to false (Production classification).

Response

Webhook created successfully

idstring uuid

Unique identifier for the webhook subscription.

urlstring nullable

The HTTPS URL where webhook events will be delivered.

eventsstring[] nullable

Array of event types this subscription is interested in.

isActiveboolean

Whether this webhook subscription is active.

createdUtcstring date-time

Timestamp when the webhook subscription was created (UTC).

updatedUtcstring date-time

Timestamp when the webhook subscription was last updated (UTC).

disabledReasonstring nullable

Reason why the webhook was automatically disabled (if IsActive is false).

secretstring nullable

Secret key for HMAC-SHA256 signature verification. Only returned on creation or secret regeneration — never exposed again for security.

isTestModeboolean

True when the subscription has DataClassification.Test classification; false for all other classifications (Production, Demo). Computed as Classification != DataClassification.Production.