Webhooks

Create a new webhook subscription.

Changed on

Creates a new webhook subscription for receiving real-time event notifications.

Available Events (assigned/working-partner role):

  • case.assigned - Case validated by Debitura and assigned to your agency
  • case.updated - Case lifecycle changed (e.g., Active → Paused). Does not cover engagement phase changes (Pre-legal/Legal/Enforcement) — poll GET /cases/{id} or GET /cases/{id}/timeline for the current phase; there is no phase-change event today.
  • case.closed - Case closed
  • payment.created - Payment registered on case
  • payment.deleted - Payment reversed (deleted) on case
  • chat.created - Chat message created on case

Managing-role events (explicit opt-in): managed_case.created, managed_case.assigned, managed_case.updated, managed_case.closed, managed_case.declined, managed_case.payment.created, managed_case.payment.deleted, managed_case.chat.created. You may configure these subscriptions before managing-webhook delivery is enabled. Notifications remain inactive until enabled; synthetic managed fire returns 422 while disabled. Notifications contain minimal event facts; chat body and close/decline comments are omitted. Detailed content uses the authorized managing-case API. Managed chat notifications and history require the current active engagement. Payment deletion repeats the original payment snapshot; the event name identifies its reversal. Existing subscriptions are never automatically opted in.

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

Requirements: HTTPS URL required. Deliveries retry with exponential backoff (8 attempts). Webhook auto-disables after max failures.

post/webhooks

Request

  • Base URL
    https://collectionpartner-api.debitura.com
  • URL
    https://collectionpartner-api.debitura.com/webhooks
  • Auth
    API key in header XApiKey

Request body

urlstring uri required
eventsstring[] required
isTestModeboolean

Response

Webhook created successfully

idstring uuid
urlstring nullable
eventsstring[] nullable
isActiveboolean
createdUtcstring date-time
updatedUtcstring date-time
disabledReasonstring nullable
secretstring nullable
isTestModeboolean

Changes

    • breaking

      the request property's maxLength was decreased to 800 (media type: application/json-patch+json)

    • breaking

      the request property's maxLength was decreased to 800 (media type: application/json)

    • breaking

      the request property's maxLength was decreased to 800 (media type: text/json)

    • breaking

      the request property's maxLength was decreased to 800 (media type: application/*+json)