Webhook endpoints
Delete a webhook endpoint
DELETE/api/v1/webhook_endpoints/{id}
Removes the endpoint and its deliveries: nothing more is sent to it. Deleting an endpoint that is already gone is not found.
Needs a key with submit permission.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | required | A webhook endpoint ID (whe_...). |
Response
The endpoint that was deleted. Status 200.
| Name | Type | Description |
|---|---|---|
| id | string | An ID that starts with whe_. |
| object | string | Always `webhook_endpoint`. |
| deleted | boolean | Always `true`. |
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 -X DELETE "https://sandbox.myclaimhouse.com/api/v1/webhook_endpoints/whe_01JM000000E008000000000021" \
-H "Authorization: Bearer $CLAIMHOUSE_KEY"Example response: 200
{
"id": "whe_01JM000000E008000000000021",
"object": "webhook_endpoint",
"deleted": true
}