Перейти к основному содержанию
POST
Настройка вебхука

Настройка вебхука

Задаёт URL вебхука для аккаунта. URL один на аккаунт, и оба события идут на него.
API-ключом эту ручку вызвать нельзя. Смена URL вебхука — как и чтение секрета подписи — требует сессии, которую вы открыли сами на сайте. С API-ключом запрос отклоняется:
Response
Иначе украденного ключа хватило бы, чтобы направить ваши события на чужой сервер. Задавайте URL в Dashboard → API — там же показан секрет подписи.

Тело запроса

string
обязательно
URL вебхука. На этой ручке только HTTPS, и он не должен указывать на localhost, 127.0.0.1, 0.0.0.0 или ::1. Дополнительно доставка отклоняется в момент отправки на любой хост, который резолвится в приватный, loopback или link-local адрес.

Ответ

string
Настроенный теперь URL.
string
Секрет подписи для X-Webhook-Signature. Генерируется при первой установке URL на аккаунте и дальше не меняется.
Response

Дверь кабинета

Кабинет пользуется второй парой ручек над теми же account-level полями — GET /api/v1/account/webhook для чтения URL и секрета и PATCH /api/v1/account/webhook для установки и очистки. Значения те же, с двумя отличиями: PATCH принимает и http://-адрес, а {"webhook_url": null} очищает вебхук. Очистка URL сохраняет секрет, поэтому повторное включение вебхука не обесценивает уже выкаченный у вас код проверки. Обе ручки тоже требуют сессии на сайте.