Webhooks
Update Webhook
Change, disable or enable a webhook
PATCH
/
api
/
v1
/
webhooks
/
{id}
curl --request PATCH \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"status": "enabled"
}'
{
"id": "4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d",
"url": "https://partner.example.com/webhooks/aniva",
"description": "Production",
"enabled_events": [
"appointment.confirmed",
"appointment.results.completed",
"home_kit_order.results.completed"
],
"alert_emails": ["ops@partner.example.com"],
"status": "enabled",
"disabled_at": null,
"disabled_reason": null,
"failing_since": null,
"previous_secret_expires_at": null,
"created_at": "2026-10-15T08:00:00.000Z",
"updated_at": "2026-10-16T07:30:00.000Z"
}
{
"error": "Webhook not found"
}
{
"error": "Aniva disabled this endpoint. Contact Aniva to enable it."
}
Change a webhook. Send only the fields you want to change. Send
status: "enabled" to
start a disabled webhook again. See Failure notices.
Requires the
webhooks_manage scope.Request
Path parameters
string
required
Webhook identifier (UUID).
Body parameters
string[]
New list of event types. Replaces the old list.
string[]
New list of 1 to 5 addresses. Replaces the old list.
string
New description, at most 500 characters.
null clears it.string
enabled or disabled. Disabling cancels the pending deliveries.Response
On success, the API returns200 OK with the updated webhook.
string
required
Webhook identifier (UUID).
string
required
The HTTPS URL Aniva posts events to.
string
Free text for your own reference. May be
null.string[]
required
Event types this webhook receives.
* means every type.string[]
required
Addresses Aniva emails when deliveries keep failing.
string
required
enabled or disabled.string
ISO 8601 UTC instant the webhook was disabled.
null while enabled.string
Why the webhook was disabled. See Failure notices.
null
while enabled.string
ISO 8601 UTC instant the current failure streak started.
null when the last delivery succeeded.string
ISO 8601 UTC instant the previous secret stops signing.
null when no rotation is in progress.string
required
ISO 8601 UTC instant the webhook was created.
string
required
ISO 8601 UTC instant of the last change.
Error responses
| Status | Description |
|---|---|
400 | Invalid request. See the error message. |
401 | Invalid API key. |
403 | No API key, or an API key without the webhooks_manage scope. |
404 | Webhook not found, or it belongs to another API key. |
409 | status: "enabled" on a webhook that Aniva disabled. Contact Aniva to enable it. |
500 | Internal server error. |
curl --request PATCH \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"status": "enabled"
}'
{
"id": "4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d",
"url": "https://partner.example.com/webhooks/aniva",
"description": "Production",
"enabled_events": [
"appointment.confirmed",
"appointment.results.completed",
"home_kit_order.results.completed"
],
"alert_emails": ["ops@partner.example.com"],
"status": "enabled",
"disabled_at": null,
"disabled_reason": null,
"failing_since": null,
"previous_secret_expires_at": null,
"created_at": "2026-10-15T08:00:00.000Z",
"updated_at": "2026-10-16T07:30:00.000Z"
}
{
"error": "Webhook not found"
}
{
"error": "Aniva disabled this endpoint. Contact Aniva to enable it."
}
⌘I
curl --request PATCH \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"status": "enabled"
}'
{
"id": "4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d",
"url": "https://partner.example.com/webhooks/aniva",
"description": "Production",
"enabled_events": [
"appointment.confirmed",
"appointment.results.completed",
"home_kit_order.results.completed"
],
"alert_emails": ["ops@partner.example.com"],
"status": "enabled",
"disabled_at": null,
"disabled_reason": null,
"failing_since": null,
"previous_secret_expires_at": null,
"created_at": "2026-10-15T08:00:00.000Z",
"updated_at": "2026-10-16T07:30:00.000Z"
}
{
"error": "Webhook not found"
}
{
"error": "Aniva disabled this endpoint. Contact Aniva to enable it."
}