> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Отримати вебхук

> Отримати один вебхук

Отримай один вебхук. Відповідь ніколи не містить секрету для підпису.

> [!NOTE]
>
> Потребує дозволу `webhooks_manage`.

## Запит

### Параметри шляху

**id** `string` *required*

Ідентифікатор вебхука (UUID).

## Відповідь

У разі успіху API повертає `200 OK` із вебхуком.

**id** `string` *required*

Ідентифікатор вебхука (UUID).

**url** `string` *required*

HTTPS URL, на який Aniva надсилає події.

**description** `string`

Довільний текст для власних нотаток. Може бути `null`.

**enabled\_events** `string[]` *required*

[Типи подій](https://docs.anivahealth.com/uk/concepts/webhooks.md#podiyi), які отримує цей вебхук. `*` означає всі типи.

**alert\_emails** `string[]` *required*

Адреси, на які Aniva надсилає листи, коли доставки постійно завершуються помилкою.

**status** `string` *required*

`enabled` або `disabled`.

**disabled\_at** `string`

Час у форматі ISO 8601 UTC, коли вебхук вимкнули. `null`, поки він увімкнений.

**disabled\_reason** `string`

Причина вимкнення вебхука. Див. [Сповіщення про збої](https://docs.anivahealth.com/uk/concepts/webhooks.md#spovischennya-pro-zboyi). `null`,
поки він увімкнений.

**failing\_since** `string`

Час у форматі ISO 8601 UTC, коли почалася поточна серія збоїв. `null`, якщо остання доставка була успішною.

**previous\_secret\_expires\_at** `string`

Час у форматі ISO 8601 UTC, коли попередній секрет перестане використовуватися для підпису. `null`, якщо ротація не триває.

**created\_at** `string` *required*

Час у форматі ISO 8601 UTC, коли вебхук створили.

**updated\_at** `string` *required*

Час останньої зміни у форматі ISO 8601 UTC.

## Відповіді з помилками

| Статус | Опис |
| - | - |
| `400` | Некоректний запит. Див. повідомлення `error`. |
| `401` | Недійсний API-ключ. |
| `403` | Немає API-ключа або API-ключ без дозволу `webhooks_manage`. |
| `404` | Вебхук не знайдено, або він належить іншому API-ключу. |
| `500` | Внутрішня помилка сервера. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "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-15T08:00:00.000Z"
}
```

```json 404 theme={null}
{
  "error": "Webhook not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.