Webhook endpoints
Get a webhook endpoint
GET/api/v1/webhook_endpoints/{id}
One webhook endpoint of the key's organization and mode, without its signing secret.
Needs a key with read permission.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | required | A webhook endpoint ID (whe_...). |
Response
The endpoint. Status 200.
| Name | Type | Description |
|---|---|---|
| id | string | An ID that starts with whe_. |
| object | string | Always `webhook_endpoint`. |
| url | string | |
| description | string | |
| event_types | array of string or null | The 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`. |
| status | string | One of: `enabled`, `disabled`. |
| mode | string | One of: `test`, `live`. |
| created_at | string (date-time) |
Errors
| HTTP status | Code | What it means |
|---|---|---|
| 401 | UNAUTHORIZED | A valid API key is required. Send it as "Authorization: Bearer <key>". |
| 403 | PERMISSION_DENIED | This API key is not allowed to do that. |
| 404 | NOT_FOUND | Not found. |
| 422 | INVALID_REQUEST | The request is not valid. |
| 504 | TIMEOUT | The 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). |
| 500 | INTERNAL | Something went wrong on our side. Quote the request ID if you contact us. |
Example
Example request
curl "https://sandbox.myclaimhouse.com/api/v1/webhook_endpoints/whe_01JM000000E008000000000021" \
-H "Authorization: Bearer $CLAIMHOUSE_KEY"Example response: 200
{
"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"
}