Skip to main content

Referral Partners: Webhook events (business meaning glossary)

This glossary explains what each Referral Partner webhook event means in business terms. Use it to understand when events fire and what they signal about your clients' status. For technical payload details and implementation guidance, see Developer Docs.

Updated over a week ago

Event overview

Debitura sends webhook notifications to referral partners for six event types. These events fall into two categories: client onboarding/linking events and case lifecycle events.

Event

Category

What it signals

client.onboarding.poa_signed

Onboarding

Client signed the Power of Attorney

client.onboarding.contract_signed

Onboarding

Client signed the contract and completed onboarding

client.linked

Linking

Existing client approved your link request

client.link_declined

Linking

Existing client declined your link request

case.created

Case lifecycle

A new collection case was created for a linked client

case.updated

Case lifecycle

A case changed lifecycle state

Onboarding events

client.onboarding.poa_signed

  • When it fires: A client signs the Power of Attorney (PoA) document during onboarding. This event fires in both standalone PoA signing flows and the main onboarding flow.

  • What it means: The client has authorized Debitura and collection partners to act on their behalf for debt collection. This is typically the first signing step in onboarding.

  • What to do: Update your system to reflect that the client has started onboarding. The client is not yet fully onboarded; wait for client.onboarding.contract_signed before submitting cases.

client.onboarding.contract_signed

  • When it fires: A client signs the Standard Debt Collection Agreement (SDCA) with 2FA verification. This marks the completion of onboarding.

  • What it means: The client is fully onboarded and ready to submit cases. You can now start submitting cases on their behalf.

  • What to do: Mark the client as fully onboarded in your system. You can now begin submitting cases for this client.

Linking events

Linking events occur when you attempt to connect with a client that already exists in Debitura. A link request is sent to the existing client for approval.

client.linked

  • When it fires: An existing Debitura client approves your link request.

  • What it means: The client has granted you access. Because the client already existed before your referral, they are marked as non-attributed. You earn fees only for cases submitted through your integration, not for cases the client creates directly in Debitura.

  • What to do: Mark the client as linked in your system. You can now submit cases on their behalf.

client.link_declined

  • When it fires: An existing Debitura client declines your link request.

  • What it means: The client chose not to connect their Debitura account with your platform. You cannot submit cases on their behalf.

  • What to do: Update your system to reflect the declined status. Consider displaying a message to the user explaining they need to approve the connection in Debitura to use your debt collection features.

Case lifecycle events

Case events are sent for all clients you have active links with. Each event identifies the client it belongs to.

case.created

  • When it fires: A new collection case is created for one of your linked clients.

  • What it means: A debt has been submitted for collection. The case will proceed through lifecycle states from verification through active collection to closure.

  • What to do: Record the case in your system. You can track this case through subsequent case.updated events.

case.updated

  • When it fires: A case transitions from one lifecycle state to another.

  • What it means: The case has progressed (or moved backward) in the collection process. The event payload tells you exactly what the previous and new states are.

  • What to do: Update the case status in your system to reflect the new lifecycle state. Consider notifying your user when cases reach key milestones (e.g., becoming Active or Closed).

Lifecycle state reference

When a case changes state, the event includes the new lifecycle value. Here is what each state means:

Lifecycle Value

Meaning

Pending contract signing

Client has not yet signed the required agreements

Pending Verification Internal

Debitura is reviewing the case

Pending Verification

Collection partner is reviewing the case

More Info Required

Partner needs additional information from the client

Pending quote by partner

Case is being distributed to partners for quotes

Quote given by partner

Partner(s) have submitted quotes; awaiting client selection

Active

Case is in active collection

Paused

Collection activity temporarily suspended

Closed

Case is closed (paid, written off, or otherwise resolved)

For detailed explanations of each state and the allowed transitions, see Case lifecycle (deep dive).

Attribution and fee eligibility

Attribution status in onboarding and linking events indicates whether you are credited as the referral source for this client.

  • Attributed clients : You referred this client to Debitura. You earn referral fees on all their cases, regardless of how the cases are created.

  • Non-attributed clients : The client already existed in Debitura before your link. You earn fees only for cases created through your integration.

This distinction prevents double-dipping on existing relationships while rewarding partners who bring new clients to the platform.

Developer Docs

Developers: For technical implementation details including payload schemas, signature verification, and endpoint references, see Developer Docs: Webhooks and Developer Docs: Referral Partner API.

Related articles

Did this answer your question?