v

latestOpenAPI 3.0.42026-08-082281222.3 KB
Webhooks

Trigger a test webhook event (test environment only)

Triggers a realistic webhook delivery through the real pipeline (queue → dispatcher → HMAC-signed HTTP delivery).

⚠️ TEST ENVIRONMENT ONLY - Returns 403 in production. Use testreferral-api.debitura.com for testing.

How it works:

  • Looks up real entity data (case or client link) to construct a realistic payload
  • Publishes through the same pipeline as production events (signature verification, retries, etc.)
  • Returns immediately after enqueueing — delivery is async via Azure Queue

Case events (case.created, case.updated, case.closed):

  • Requires caseId — must be a real case belonging to a linked client
  • For case.updated: optionally provide oldLifecycle and newLifecycle (defaults to current → Closed)
  • For case.closed: optionally provide closeCode and closeComment (defaults to Paid)

Client events (client.linked, client.link_declined, client.link_requested, client.link_expired, client.onboarding.poa_signed, client.onboarding.contract_signed):

  • Requires externalTenantId — must be an active client link belonging to your account
post/v1/Webhooks/test

Request body

eventTypestring required

The webhook event type to trigger (e.g. "case.updated", "client.linked")

caseIdstring uuid nullable

Required for case.created, case.updated, and case.closed events

externalTenantIdstring nullable

Required for client.* events (client.linked, client.link_declined, client.onboarding.*)

oldLifecyclestring nullable

Optional override for case.updated: the "from" lifecycle (defaults to current case lifecycle)

newLifecyclestring nullable

Optional override for case.updated: the "to" lifecycle (defaults to "Closed")

closeCodestring nullable

Optional override for case.closed: the close code (defaults to "Paid")

closeCommentstring nullable

Optional override for case.closed: a close comment

Response

Test event enqueued successfully

eventTypestring nullable
enqueuedCountinteger
messagestring nullable