Вебхуки
Обновить вебхук
Изменить, отключить или включить вебхук
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."
}
Изменяет вебхук. Передай только те поля, которые хочешь изменить. Отправь
status: "enabled", чтобы
снова включить отключённый вебхук. См. Уведомления о сбоях.
Требуется scope
webhooks_manage.Запрос
Параметры пути
Параметры тела запроса
Новый HTTPS URL. Те же правила, что и при создании.
Ответ
При успехе API возвращает200 OK с обновлённым вебхуком.
Типы событий, которые получает этот вебхук.
* означает все типы.Адреса, на которые Aniva отправляет письма, если доставки продолжают завершаться ошибкой.
Причина отключения вебхука. См. Уведомления о сбоях.
null,
пока он включён.Момент начала текущей серии ошибок в формате ISO 8601 (UTC).
null, если последняя доставка прошла успешно.Момент в формате ISO 8601 (UTC), когда предыдущий секрет перестаёт использоваться для подписи.
null, если ротация не выполняется.Ответы с ошибками
| Статус | Описание |
|---|---|
400 | Некорректный запрос. См. сообщение error. |
401 | Неверный API-ключ. |
403 | API-ключ не передан или у него нет права доступа webhooks_manage. |
404 | Вебхук не найден или принадлежит другому API-ключу. |
409 | status: "enabled" для вебхука, который отключила Aniva. Свяжись с Aniva, чтобы включить его. |
500 | Внутренняя ошибка сервера. |
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."
}