Skip to the page
Chapters

Webhook endpoints

List webhook endpoints

GET/api/v1/webhook_endpoints

The webhook endpoints of the key's organization in the key's mode, newest first. All are returned (at most 10): next_cursor is always null. The signing secret is never included.

Needs a key with read permission.

Request

This request takes no parameters and no body.

Response

The endpoints. Status 200.

Response fields
NameTypeDescription
dataarray of object
data[].idstringAn ID that starts with whe_.
data[].objectstringAlways `webhook_endpoint`.
data[].urlstring
data[].descriptionstring
data[].event_typesarray of string or nullThe event types sent to this endpoint; null for every type.Each item is one of: `eligibility.completed`, `api_key.created`, `api_key.revoked`, `claim.validated`, `claim.needs_attention`, `claim.queued`, `claim.submitted`, `claim.accepted`, `claim.rejected`, `claim.status_updated`, `claim.voided`, `batch.acknowledged`, `attachment.completed`, `payer_request.received`, `era.received`, `claim.paid`, `claim.denied`, `claim.payment_reversed`, `predetermination.returned`.
data[].statusstringOne of: `enabled`, `disabled`.
data[].modestringOne of: `test`, `live`.
data[].created_atstring (date-time)
next_cursorvaluePass as cursor to get the next page; null when there is no next page.

Errors

Errors
HTTP statusCodeWhat it means
401UNAUTHORIZEDA valid API key is required. Send it as "Authorization: Bearer <key>".
403PERMISSION_DENIEDThis API key is not allowed to do that.
422INVALID_REQUESTThe request is not valid.
504TIMEOUTThe request took too long to finish. It may still have taken effect: look it up before sending it again with a new Idempotency-Key. What it made is found with GET /api/v1/eligibility?request_id=<this request_id>, and the same filter on /api/v1/claims and /api/v1/attachments (a key with read permission).
500INTERNALSomething went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell
curl "https://sandbox.myclaimhouse.com/api/v1/webhook_endpoints" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON
{
  "data": [
    {
      "id": "whe_01JM000000E008000000000021",
      "object": "webhook_endpoint",
      "url": "https://hooks.example.com/claimhouse",
      "description": "Billing system",
      "event_types": [
        "eligibility.completed"
      ],
      "status": "enabled",
      "mode": "test",
      "created_at": "2026-03-10T15:00:00.000000+00:00"
    }
  ],
  "next_cursor": null
}