Вебхуки

Что такое вебхуки

Вебхук – это механизм оповещения о происходящих в системе событиях посредством функций обратных вызовов. Когда случается событие, сервер отправляет HTTP-запрос на URL-адрес, предоставленный клиентом для приема вебхуков. Например, событиями являются: создание нового платежа, изменение его статуса или суммы.

Как активировать вебхуки

Для активации функционала, владельцу компании нужно перейти на страницу настройки вебхуков, указать URL куда будут отправляться вебхуки и активировать.

Как работают вебхуки

При создании в системе события, на указанный URL-адрес в настройках отправляется POST запрос c телом объекта в формате JSON.

На данный момент вебхуки срабатывают на следующие события:

- При создании платежа
- При изменении статуса и суммы платежа
- При создании возврата

Структуру вебхуков вы можете посмотреть на странице API документации.
Вы так же можете просмотреть логи отправки вебхуков на соответствующей странице в разделе Логи.

Если, при отправки вебхука, система не получит ответ с HTTP кодом 2xx, вебхук будет отправлен повторно.
Если вебхук был отправлен 5 раз подряд с ошибкой, система деактивирует вебхуки, а на почту владельца компании будет отправлено соответствующее уведомление.

Последнее изменение: 13/07/2023