Вебхуки
Вебхуки — это механизм, с помощью которого можно вызывать произвольные http-сервисы при наступлении определённых событий.
Например:
- передать внешней системе, что нужно начислить баллы клиенту за брошенную корзину.
- поставить задачу в коллцентр о том, что нужно обзвонить неактивного клиента.
- передать статусы подписки клиента в учётную систему.
Требования к веб-сервису
- Поддерживаемые http-методы:
GET,POST,PUT,PATCHиDELETE - Поддерживаемые методы авторизации:
Basic,Bearer URIзапроса,http-заголовки и тело запроса произвольные, при формировании доступен язык шаблонизатора.- Если вызов отправляется на
https-сервис, то этот сервис должен иметь валидный сертификат.
Идемпотентность
Чтобы избежать повторной обработки вызова веб-сервисом (например, повторных начислений баллов), необходимо использовать вебхуки с ключом идемпотентности ${WebhookRequest.TransactionalId}.
Идемпотентность работает следующим образом:
- сервис внешней системы возвращает код ответа
2xx Success→ вызов считается успешным и повторен не будет; - сервис внешней системы не дает ответ в течение 30 секунд или возвращает ответы
5xxили429→ вызов повторится максимум 3 раза в течение 6 минут; - сервис внешней системы возвращает другой ответ → вызов не повторяется.
Логи
Логи всех отправок вместе с ответами хранятся на проекте 30 суток.
Также их можно выгрузить по API.
Примеры
Изменение статуса подписки
Начисление баллов
Last modified on