Вебхуки
Отправить тестовое событие
Отправить событие 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. Вызов завершается сразу.
Следи за результатом в Списке доставок.
Требуется scope
webhooks_manage.Запрос
Параметры пути
Ответ
При успехе API возвращает202 Accepted.
Ответы с ошибками
| Статус | Описание |
|---|---|
400 | Некорректный запрос. См. сообщение error. |
401 | Неверный API-ключ. |
403 | 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."
}