Получать события вебхуком
Если у вас есть CRM или свой сервис, кабинет может сам слать туда каждое
новое событие — это вебхук: на ваш адрес приходит POST с JSON. Всё
настраивается на вкладке «Интеграции», раздел «Вебхуки».
Настроить
Заголовок раздела «Настроить»- «Добавить вебхук» — название и публичный адрес вашего сервиса
(
https://…). - «Тест» — платформа пошлёт проверочный запрос
pingи скажет, ответил ли адрес; результат останется в журнале доставок строкой «проверка связи». - «Подписать» вебхук на нужные источники. С этого момента на каждое
новое событие источника уйдёт
POST.
Подписка шлёт события, принятые после неё. Запросов не шлют: история до подписки, загрузка файла, первый запуск опроса, пустое событие, удалённое событие и повторная отправка (двойной щелчок по кнопке формы).
Ответить и пережить повтор
Заголовок раздела «Ответить и пережить повтор»Ваш сервис должен ответить кодом 2xx. Иначе платформа повторит доставку
с растущим интервалом — 30 секунд, минута, две… до суток; событие в кабинете
есть в любом случае. Журнал попыток — в карточке вебхука.
Доставка «хотя бы раз»: одно и то же событие с тем же id может прийти
повторно — приём должен это пережить (например, не создавать вторую сделку
с тем же номером события).
Проверить подпись
Заголовок раздела «Проверить подпись»Каждый запрос подписан: заголовок X-Goodwink-Signature содержит время
и HMAC-SHA256 от тела. Секрет — в карточке вебхука, кнопка «Показать». Как
считать подпись и что лежит в теле — Вебхук: формат и подпись.
Только публичный http(s): адрес во внутренней сети платформа не примет.
Адрес проверяется при сохранении и перед каждой отправкой, и запрос идёт
ровно на проверенный адрес.
Отписаться — «×» у источника в карточке вебхука; «Удалить» убирает вебхук вместе с журналом.