Browse documentation

WEBHOOKS

Event types

Every event is a stable envelope; the data.object payload matches the corresponding API resource.

Envelope

{
  "id": "evt_9f2c41…",
  "type": "payment.succeeded",
  "api_version": "2026-08-31",
  "created_at": "2026-09-01T12:00:00.000Z",
  "livemode": true,
  "data": {
    "object": {
      "object": "payment",
      "charge_id": "TR_…",
      "case_id": "c3d4…",
      "amount_cents": "500"
    }
  }
}

id is stable forever and is your deduplication key. api_version is currently 2026-08-31.

All event types (19)

debtor.createdcase.createdpayment.succeededpayment.failedpayment.refundedarrangement.createdarrangement.updatedarrangement.defaultedconversation.escalatedconversation.resumedpromise.createdpromise.keptpromise.brokenmessage.receivedmessage.sentdispute.openeddispute.lostcase.status_changedcase.closed

Subscribe an endpoint to specific types, or leave its event list empty to receive all of them.