Webhooks
Webhooks (вебхуки)
Для настройки взаимодействия между Adesk и вашим приложением в режиме реального времени, можно использовать этот мощный и простой механизм.
Что такое вебхук?
Вебхук представляет собой механизм отправки уведомлений в системе и является способом информирования клиентского приложения о наступлении события. Под событием понимается изменение состояния системы, такие как создание обязательств или удаление операции из сервиса. Уведомление представляет собой POST-запрос, содержащий информацию о типе события и ссылку на объект, который претерпел изменения. Непосредственно сам вебхук содержит описание изменения (тип объекта и ссылку на изменившийся объект), которое отправляется на указанный url.
_____________________________________________________________________________________
⚠️ Важно
Несмотря на легкость использования вебхуков, необходимо учитывать, что подписка на них — это только форма уведомления об изменениях в системе. Действия с сущностями необходимо выполнять с помощью API.
_____________________________________________________________________________________
Примеры использования, когда подойдет подписка через вебхуки:
- Создание, изменение, подтверждение или удаление операции
- Создание либо удаление обязательства
- Создание, удаление либо завершение проекта
События отправляются методом POST и ожидают ответ со статусом 200. При получении ответа с ошибочным статусом, событие будет доставляться повторно по следующему графику:
- сразу
- через 5 секунд
- через 5 минут
- через 30 минут
- через 2 часа
- через 5 часов
- через 10 часов
- еще через 10 часов
_____________________________________________________________________________________
Вебхуки операций
После того как в сервисе были произведено создание, изменение, подтверждение или удаление операции, срабатывает вебхук, который автоматически отправляет уведомление о совершенном действии в приложение, с которым настроена интеграция.
_____________________________________________________________________________________
Вебхуки обязательств
После создания или удаления обязательства, вебхук автоматически проинформирует об этом, направив соответствующее уведомление в интегрированные приложения.
_____________________________________________________________________________________
Вебхуки контрагентов
С помощью вебхуков можно отслеживать создание или изменение контрагентов в сервисе — дата, время, тип события будут отправлены в виде уведомления.
_____________________________________________________________________________________
Вебхуки проектов
HTTP-запрос передается при создании, удалении или завершения проекта. Когда статус проекта меняется в сервисе, с помощью вебхуков отправляется информация об этих изменениях в мессенджер или другие, подключенные через вебхуки, приложения.
_____________________________________________________________________________________
Вебхуки согласования платежей
С событием создания заявки на расход, передачи ее на оплату и об оплате заявки связываются вебхуки, соответствующие уведомления будут направлены в подключенные приложения. В уведомлении будут все данные о заявке, необходимые для дальнейшей работы с ней.
_____________________________________________________________________________________
⚠️ Важно
Если все попытки закончились неудачей, уведомление считается неотправленным и в последствии удаляется, в клиентское приложение оно не отправляется из-за проблемы на стороне клиентского приложения.
Ограничения при работе
В работе с вебхуками обязательно требуется учесть ограничения, которые могут влиять на безопасность и надежность взаимодействия между приложениями.
Вебхуки могут потеряться при сбоях в доставке.
Клиентский сервер должен быть всегда доступным, чтобы избегать пропущенных уведомлений.
Вебхуки могут генерировать большие объёмы данных, а это, в свою очередь, требует масштабирования оптимизации обработки данных на стороне пользователя.
Провайдеры могут установить лимиты на запросы и частоту уведомлений.
Рекомендуется вести журнал событий и отслеживать работу вебхуков.
Как проверить, что вебхук работает?
Для проверки работоспособности вебхука удобен сервис https://webhook.site/ . Он создает уникальный тестовый url, который необходимо указать в вебхуке, и интерактивно показывает входящие запросы, т.е. уведомления вебхуков.
Для прочих поддерживаемых банков вы можете посмотреть инструкции ниже
| Тинькофф Банк | Уралсиб | Альфа-банк | Модульбанк | Точка | СберБанк |
| Банк СПб | Совкомбанк | Банк ВТБ | Газпромбанк | Бланк | Дзен-мани |