В

Вебхук

Вебхук — это способ оповещения клиента о произошедшем в системе событии с помощью пользовательских обратных вызовов по HTTP.

Это термин из мира WEBа и программирования. Вебхук запускается, когда на вашем сайте, в CRM, чат-боте или иной системе происходит какое-то событие. Например, человек написал комментарий или в товароучетную систему добавили новый товар. Когда происходит такое событие, сервер создает HTTP-вызов и отправляет его на адрес, указанный клиентом для получения вебхуков. Клиент вовремя получает свежие данные — клиент доволен.

Пользователь может настроить веб-хук так, чтобы события на одних сайтах вызывали действия на другом. Например, человек создает в интернет-магазине заказ → система отправляет вебхук в приложение владельца → приложение уведомляет владельца и отправляет человеку смету.

Зачем нужен вебхук, если есть API

Большинство API работает по принципу «Спроси меня и я отвечу». То есть для получения свежих данных, программному клиенту нужно постоянно отправлять запросы на сервер. Вебхуки работают иначе. Они как бы говорят: «Дружище, больше не нужно названивать. Если произойдет что-то для тебя важное, я сам сообщу».Схема запроса обратной связи по API. Программный клиент регулярно опрашивает сервер о наличии изменений. Если их нет, сервер дает отрицательный ответ. Если есть — оповещает об изменениях

Если простыми словами, вебхук — как бы подписка на обновления для определенных событий. Сервер будет оповещать клиента только о тех изменениях, которые ему по-настоящему важны. Он сам сообщит об этих событиях при настройке вебхука.

Это упрощает процесс обмена данными и для программного клиента, и для провайдера. Не забываем, что вебхук — это обратный вызов по HTTP. При настройке не потребуется громоздкая инфраструктура из кода.Схема передачи данных в случае применения вебхука. Сервер сам оповещает клиента, если появится интересующая его информация. Постоянно отправлять запросы не нужно

Обычно вебхук запрашивает данные у сервера в форме POST-запроса, а программный клиент интерпретирует его самостоятельно. Для этого на клиентской стороне строится интерфейс взаимодействия с POST-запросом. Пользователь самостоятельно определяет случаи, при которых сервер должен оповестить об изменениях, вебхук захватывает данные и передает клиенту, а тот их идентифицирует и интерпретирует.

Когда применяется API, адреса для запроса данных формируются и предоставляются клиенту самим сервером. Программный клиент вызывает эти адреса и получает интересующие его изменения. Или не получает, если их нет.Пример запросов к API от клиентского приложения. Клиент запрашивает данные о созданных и прочитанных сообщениях и комментариях

Вебхук работает в обратном порядке: URLы для отправки запроса формируется клиентом. А сервер, если на его стороне происходит важное для пользователя событие, использует эти URLы для отправки оповещения программному клиенту.

Представим, что пользователь хочет получать уведомления всякий раз, когда на его площадке появляется новое сообщение. Он создает необходимый интерфейс и настраивает вебхуки. Затем:

  1. Какой-то пользователь публикует сообщение
  2. Сообщение появляется в базе данных сервера
  3. Сервер вызывает адрес вебхука
  4. Программный клиент получает уведомление о том, что доступно новое сообщение

Как выглядит вебхук

По сути, вебхук — это программный код. Обычно он состоит из двух частей — переменной и самих данных. Например, как здесь.«First name» — это переменная, а «Anton» — это данные, которые передаются с помощью вебхука, которые постоянно меняются и подставляются системой. Количество переменных определяется софтом, на события в котором реагирует вебхук

Предпринимателю, маркетологу и другому обывателю не нужно понимать, а тем более составлять код. Почти всегда система сама составляет код и отправляет его в виде запроса на указанный клиентом адрес. А там этот код отображается уже в графическом интерфейсе в виде набора данных.

Как используют вебхуки на практике

Сегодня вебхуки используются повсеместно. Вот несколько примеров на скорую руку:

  1. Github — веб-сервис для хостинга IT-проектов и их совместной разработки, использует вебхуки, чтобы оповещать владельцев аккаунтов о новых сообщениях, выпущенных обновлениях, иных события
  2. Мой склад — отечественная систему управления торговлей, использует вебхуки для оповещения клиентов о создании покупателями заказов и изменении их статусов, изменении цены товара, обновлении номера телефона контрагента и т.д.
  3. Callibri — система коллтрекинга, использует вебхуки для оповещения сторонних систем клиента о совершенных звонках, полученном электронном письме, заявке, сообщении в чате

Чтобы упростить работу с вебхуками, поставщики данных предоставляют пользователям готовые интерфейсные панели. На них можно создать новый вебхук, указать URL, на который будет отправлен вызов, выбрать событие и передаваемые параметры. Пользователю не нужно возиться с кодом — он заполняет простую форму, а за программную часть работы отвечает поставщик данных.Панель для создания и управления вебхуками от сервиса Callibri. Пользователь указывает адрес для отправки запроса, задает событие и его параметры. А все остальное делает сам сервис

Создаем тестовый вебхук

Кажется, что работать с вебхуками, при наличии программной панели от поставщика данных, просто. Перейдем от теории к практике — посмотрим, как это работает на примере.

Чтобы создать тестовый вебхук, не нужен свой сайт или приложение. Проверить работоспособность входящего запроса можно с помощью специального сервиса — Webhook.site. Он генерирует для вас тестовый урл, который можно использовать для отправки POST-запроса и проверки его содержимого на этом же сайте. Показываем, как это работает. Для проверки будем использовать свой репозиторий на Github.

  1. Переходим на Webhook.site. Получаем сгенерированный урл, копируем его в буфер обмена
  2. Оставляем страницу сервиса открытой. Скопированный адрес передаем провайдеру данных. Для этого используем свой репозиторий на Github. В нем переходим в раздел настроек, выбираем раздел с вебхуками и настраиваем новый
  3. Заполняем открывшуюся форму. Вставляем скопированный адрес для отправки запроса. В строке Content type ставим application/json. А затем выбираем события, на которые будет реагировать сервис и отправлять вебхук. Для тестирования инструмента выбираем в качестве интересующего события выбираем публикацию или изменение комментариев к нашему репозиторию. Сохраняем вебхук
  4. Оставляем комментарий к коммиту и смотрим на Webhook.site, что получилось
  5. Видим, что сразу после публикации комментария поставщик данных отправил на вставленную нами ссылку POST-запрос. Слева размещено оповещение про сам запрос, а справа — детализация. Изучив информацию увидим, что провайдер отправил нам исчерпывающую информацию даже для такого простого события, публикация комментария

Если вы пользуетесь сервисом, который дает возможность отправлять уведомления с помощью вебхуков, протестируйте его похожим образом. Например, если используете Dropbox, можно протестировать отправку уведомлений для события «внесение изменения в файл».

Помощь в отладке вебхуков

Вебхуки являются ассинхронной моделью программирования, поэтому их ручная отладка часто вызывает сложности. Мы поговорили с нашим отделом разработки и они рассказали нам про несколько сервисов, которые сильно упрощают процесс отладки. Если вы программируете и отлаживаете вебхуки самостоятельно или планируете это делать, вам будет полезно знать про:

  1. Pipedream — собирает запросы вебхуков и проверяет их удобным вам способом. Создает общедоступную конечную точку, чтобы получать и проверять HTTP-запросы из любого источника, а также легко проверять заголовки, полезную нагрузку и другие данные
  2. Postman — моделирует REST и POST-запросы
  3. ngrok — локальный сервер для тестирования программного кода на вашем компьютере
  4. httpresponder — сервис для создания конечных точек сбора и ответов на вебхуки в формате JSON или XML-файлов

Безопасно ли пользоваться вебхуками

Обычно механизм использования вебхуков предусматривает доставку данных программному клиенту через публичные адреса URL. Это небезопасно: любой может перехватить эти адреса и подменить передаваемые данные в своих корыстных целях. Но этого можно избежать. Есть несколько способов:

  1. Использовать HTTPS — это расширение протокола HTTP для поддержки шифрования в целях повышения безопасности
  2. Генерировать URLы для отправки вебхуков с уникальными токенами. Например, вот такие: http:suite/index.php?tkn=9e1891552fa7b0c0686b336, где 9e1891552fa7b0c0686b336 — уникальный идентификатор
  3. Реализовать базовую идентификацию доступа по технологии HTTP Basic authentication. При получении POST-запроса программный клиент запросит имя пользователя и пароль
  4. Работать с поставщиками данных, которые подписывают отправляемые с сервера запросы специальным ключом и проверяют подлинность подписи. Например, тот же Github использует для проверки целостности переданной информации код идентификации HMAC

О чем нужно помнить, если используешь вебхуки

Возможна потеря данных. Бывает, что доставив запрос с данными программному клиенту, вебхук перестает отвечать. Обычно это связано с ошибкой на стороне сервиса. С чем бы это ни было связано, из-за такой ошибки всегд аесть риск потерять данные. Поэтому мы советуем заранее готовиться к тому, что приложение или сайт могут упасть. Узнайте заранее, как поставщик данных обрабатывает ответы и создает ли он резервные копии на случай, если сервис ляжет.

Приложение может не выдержать нагрузку. В зависимости от вида вашей деятельности и настроенных триггеров, события на стороне сервера могут происходить слишком часто. Чем больше триггеров для отправки вебхука вы задаете, тем чаще программный клиент будет получать POST-запросы. Убедитесь, что ваше приложение готово к получению запрашиваемого объема данных. Если на сервере возникнет высокая активность, клиентское приложение может не выдержать нагрузки. Так бывает, например, при DDoS-атаках.

Не стоит передавать через вебхуки данные. Технически технология вебхук позволяет передавать программному клиенту объемные массивы данных. Но делать этого не стоит. Используйте вебхуки лишь для уведомления об изменении состояния на сервере. А когда сигнал получен — вызывайте API,запрашивайте данные и получайте настоящую нагрузку. Такой способ позволяет надежнее обрабатывать данные и не перегружать систему.

Коротко про вебхук

  • Вебхук — это способ оповещения клиента о произошедшем в системе событии с помощью пользовательских обратных вызовов по HTTP
  • Вебхук — это альтернатива API. Для проверки изменения данных в API программный клиент должен самостоятельно направлять запросы на сервер и ждать ответ. Вебхук работает в обратном порядке. Пользователь указывает адрес, на который отправляется запрос в случае возникновения важного события
  • Вебхуки используют повсеместно. Чаще всего их применяют разработчики полезного клиентского софта для отправки клиентам различных оповещений об изменениях в системе. Например, о получении сообщения или добавлении нового товара
  • Чтобы клиентам было легко запускать вебхуки, разработчики софта дают доступ к специальной панели, на которой можно добавить нужный адрес, задать событие и параметры
  • Использовать вебхуки не всегда безопасно. Чтобы обеспечить конфиденциальность, используют протоколы HTTPS и другие инструменты безопасности
Мы используем cookie для вашего удобства. Используя сайт, вы соглашаетесь с этим. Подробнее - в политике конфиденциальности.
Я согласен