Вебхуки
Надіслати тестову подію
Надіслати подію ping на вебхук
POST
/
api
/
v1
/
webhooks
/
{id}
/
ping
curl --request POST \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d/ping \
--header 'x-api-key: YOUR_API_KEY'
{
"delivery_id": "7c9e1a3b-5d7f-4b2d-9e4a-6c8e0a2b4d6f"
}
{
"error": "The endpoint is disabled. Enable it first."
}
Надішли підписану подію
ping на вебхук незалежно від його enabled_events. Виклик повертає відповідь одразу.
Стеж за результатом у Списку доставок.
Потребує дозволу
webhooks_manage.Запит
Параметри шляху
Відповідь
У разі успіху API повертає202 Accepted.
Відповіді з помилками
| Статус | Опис |
|---|---|
400 | Некоректний запит. Див. повідомлення error. |
401 | Недійсний API-ключ. |
403 | Немає API-ключа або API-ключ без області доступу webhooks_manage. |
404 | Вебхук не знайдено або він належить іншому API-ключу. |
409 | Вебхук вимкнено. Спочатку ввімкни його. |
500 | Внутрішня помилка сервера. |
curl --request POST \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d/ping \
--header 'x-api-key: YOUR_API_KEY'
{
"delivery_id": "7c9e1a3b-5d7f-4b2d-9e4a-6c8e0a2b4d6f"
}
{
"error": "The endpoint is disabled. Enable it first."
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/webhooks/4a6c8e0f-2b4d-4f6a-8c0e-2a4c6e8f0b1d/ping \
--header 'x-api-key: YOUR_API_KEY'
{
"delivery_id": "7c9e1a3b-5d7f-4b2d-9e4a-6c8e0a2b4d6f"
}
{
"error": "The endpoint is disabled. Enable it first."
}