Webhook
Оглавление
На любом сайте, особенно с хорошим, активным трафиком, ежедневно происходит масса событий. Посетители регистрируются, закидывают товары в корзину, пишут отзывы, лайкают товары и т.д. Когда речь идет о собственном сервере, для отслеживания происходящего достаточно подключить систему мониторинга. Но в случае со сторонними сервисами этого сделать не получится. Никто не даст доступ к размещению скриптов, поэтому приходится пользоваться вебхуками.
Определение webhook
Сначала разберем, что означает термин. Технология Webhook – это метод отправки уведомлений пользователю онлайн-ресурса при условии, что на нем изменилась отслеживаемая информация. Например, появились новые отзывы или была скорректирована цена, остатки.
Заранее настроенная система создаст HTTP-вызов и отправит сведения заданному получателю через вебхук. Внутри сообщения обязательно присутствует тип события и ссылка на объект. Принимают их обычно автоматизировано, например, товарно-учетной системой.
Принцип работы вебхука
Вот пример срабатывания вебхука, если пользователю нужно знать о новых комментариях:
- Посетитель ресурса публикует комментарий.
- Сообщение автоматически вносится в БД сервера.
- Хост обращается к URL настроенного вебхука.
- Клиенту отправляется уведомление о новой записи.
Все, что от него требуется при настройке, это указать вид уведомления и свой адрес. Категории для отслеживания практически ничем не ограничены. Главное, чтобы они представляли собой объект, подлежащий количественному учету.
Разница между API и вебхуками
Выбор между API и вебхуком зависит от задач. На практике нередко используют оба способа для получения информации. Но с учетом специфики. Например, для API характерно получение ответа по запросу, сгенерированному автоматически или вручную.
Чтобы получить информацию с сайта через этот интерфейс, нужно обратиться к нему. Вебхуки же действуют по принципу подписки. Стоит однажды настроить уведомления и пользователю будут поступать сообщения без его участия, «на автомате».
Преимущества вебхуков проявляется в снижении нагрузки на сервер по сравнению с тем же API, потому что отправка событий осуществляется только по их наступлению, нет постоянной проверки статуса и т.п. Еще эта система не требует постоянного коннекта с сервером.
Когда использовать API, а когда вебхук
Типовые варианты применения webhook:
- Сформировать заказ, обновить его статус.
- Изменить цену на товар вслед за производителем.
- Обновить контакты партнеров, поставщиков.
В Mailganer самые популярные вебхуки — email_status, email_meta и mail_status. Они мгновенно оповещают об изменениях в статусе подписчика, данных о подписчике и статусе конкретного письма соответственно. Например, если вы изменили данные подписчика через форму или импорт, вебхук автоматически передаст обновлённые значения в CRM. Информация обновится в реальном времени, и вам не придётся вручную заносить данные в CRM.
Чтобы полноценно работать с базами, нужен интерфейс API. В нем поддерживаются необходимые функции вроде создания, изменения, удаления информации.
Примеры использования вебхуков
Примеры пользователей:
- Github. Это веб-ресурс для хостинга IT-проектов любого масштаба. На нем нередко ведут совместную разработку удаленными командами. Компания при помощи вебхуков отсылает пользователям сведения о появлении новых релизов программ, сообщениях от коллег и пр.
- Мой склад. Отечественная складская система, включая функционал управления торговлей. Через систему вебхуков в ней отправляются уведомления об изменении статуса заказа или обновлении стоимости товаров, контактов контрагентов и т.д.
- Callibri. Система коллтрекинга. Оповещает пользователей о поступивших звонках, письмах, сообщениях в онлайн-чате, установленном на сайте.
Многие поставщики услуг вебхуков разрабатывают удобные графические интерфейсы для быстрой настройки параметров. Например, у Callibri достаточно ввести отслеживаемый URL, выбрать тип события и проставить галочки на информации, какую следует включать в сообщение.
Пользователю остается лишь настроить, например, CRM на получение сведений, их распределение внутри карточки клиента и реагировать на входящие. Минимум ручного труда при максимальной эффективности.
Как создать тестовый вебхук
Последовательность действий:
- Зайдите на сайт. Система автоматом сгенерирует уникальную ссылку вебхука.
- Скопируйте URL кликом по кнопке, расположенной рядом (страницу не закрывайте).
- Зайдите в раздел настроек на интересующем вас сайте и выберите опцию «Вебхук».
- Внесите скопированную ссылку в строку для URL открывшейся формы.
- Задайте значение «application/json» в поле «Тип контента» (Content Type).
- Сохраните вебхук и вернитесь на вкладку с сайтом webhook.site.
Если процедура проведена корректно, поставщик сведений отправит ответ на отправленный запрос. Тогда слева увидите оповещение, а справа детализированный отчет.
Проверка работы вебхука
Основные шаги:
- Зайдите на сайт и скопируйте ссылку из строки, включающей подпись Your unique URL.
- Создайте вебхук и в теге URL укажите только что сгенерированную проверочную ссылку (сделали шагом выше).
- Создайте новое событие на своем ресурсе. Например, введите его через JSON API. В итоге система должна уведомить об изменениях.
Такими задачами обычно занимаются технические специалисты. Но понимать функционал стоит и тем же маркетологам, чтобы полноценно использовать для решения своих задач.
Безопасность использования вебхуков
Чтобы минимизировать негативные моменты, стоит придерживаться правил:
- Работайте через протокол HTTPS. Он поддерживает шифрование.
- Создавайте ссылки с уникальными идентификаторами, избегайте типовых фраз.
- Сотрудничайте с поставщиками, поддерживающими коды идентификации (типа HMAC).
Еще нередко используют доступ к вебхуку по технологии HTTP Basic Authentication. Это позволяет защитить систему путем запроса имени пользователя и пароля.
Понятно пишет о сложных вещах в разъяснительной Mailganer. Работает с лендингами и подсказками внутри продукта. Делает рассылки компании и отвечает за новости в Телеграм-канале.
Стать автором блога Mailganer ›