Вебхуки – механизм мгновенных уведомлений вашей системы банком при наступлении значимых событий (операции, платежи), на которые вы подписаны как партнёр API. Для получения новой информации достаточно создать вебхук (подписаться на событие), и банк сам будет отправлять уведомления по событиям.
Вебхуки сокращают количество неэффективных запросов в API и ускоряют ваши рабочие процессы за счёт автоматического уведомления при наступлении событий. Это может быть полезно, если вам необходимо обрабатывать информацию о транзакциях или платежах в реальном времени.
Доступные события
События, на которые можно подписаться:
| Событие | scope |
|---|---|
| Операции по счетам ЮЛ | transactions |
| Входящие платежи по СБП для ЮЛ | b2b-sbp |
Инструкция по подключению
- 1.Отправьте письмо на почту alfa_api@alfabank.ru с указанием
callbackUri. Требования кcallbackUriописаны ниже. - 2.Реализуйте на своей стороне открытый Партнёрский метод для получения вебхуков.
- 3.Создайте тестовый вебхук и проверьте его работу в песочнице. Подробнее в статье Тестирование вебхуков.
- 4.Подпишитесь на событие в промышленной среде. Для этого cоздайте вебхук по выбранному событию с помощью метода API или на Портале разработчика. Создание вебхука на Портале разработчика доступно только для H2H-интеграций.
Управлять вебхуками можно с помощью методов:
- •
- •
- •
- •
Просматривать информацию о вебхуках для H2H-интеграций можно на Портале разработчика во вкладке Вебхуки.
Требования к полю callbackUri
Домены первого и второго уровня хоста, который вы указываете в качестве callBackUri, должны совпадать с доменами redirect_uri вашей интеграции. Это позволяет расширить возможные варианты для callbackUri .
Например, если в качестве redirect_uri был указан https://partner.ru, то можно создать следующие callbackUri :
- •
- •
- •
- •
Для создания вебхука с другим хостом необходимо удалить уже существующий вебхук.