Перейти к основному содержанию
POST
Регистрирует HTTPS URL, который получает события вебхуков. Владельцем вебхука является твой API-ключ. Он получает события только для объектов, доступных твоему ключу на чтение. Один API-ключ может владеть не более чем 5 вебхуками.
Требуется scope 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).

Ответы с ошибками