Перейти до основного вмісту
POST
Зареєструй HTTPS URL, який отримуватиме події вебхуків. Власником вебхука є твій API-ключ. Він отримує події лише для об’єктів, які твій ключ може читати. Один API-ключ може мати щонайбільше 5 вебхуків.
Потребує дозволу webhooks_manage.

Запит

Параметри тіла запиту

string
обов'язково
HTTPS URL на порту 443 із публічним хостом і без облікових даних. Aniva не переходить за перенаправленнями.
string[]
обов'язково
Типи подій для отримання, щонайменше один. ["*"] означає всі типи. ping не можна вказувати в списку.
string[]
обов'язково
Від 1 до 5 адрес, на які Aniva надсилає листи, коли доставки постійно завершуються помилкою.
string
Довільний текст для власних нотаток, щонайбільше 500 символів.

Відповідь

У разі успіху API повертає 201 Created із вебхуком та його секретом.
string
обов'язково
Секрет для підпису, whsec_ плюс base64. Aniva показує його лише в цій відповіді. Див. Перевірка підпису.
string
обов'язково
Ідентифікатор вебхука (UUID).
string
обов'язково
HTTPS URL, на який Aniva надсилає події.
string
Довільний текст для власних нотаток. Може бути null.
string[]
обов'язково
Типи подій, які отримує цей вебхук. * означає всі типи.
string[]
обов'язково
Адреси, на які Aniva надсилає листи, коли доставки постійно завершуються помилкою.
string
обов'язково
enabled або disabled.
string
Час у форматі ISO 8601 UTC, коли вебхук вимкнули. null, поки він увімкнений.
string
Причина вимкнення вебхука. Див. Сповіщення про збої. null, поки він увімкнений.
string
Час у форматі ISO 8601 UTC, коли почалася поточна серія збоїв. null, якщо остання доставка була успішною.
string
Час у форматі ISO 8601 UTC, коли попередній секрет перестане використовуватися для підпису. null, якщо ротація не триває.
string
обов'язково
Час у форматі ISO 8601 UTC, коли вебхук створили.
string
обов'язково
Час останньої зміни у форматі ISO 8601 UTC.

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