Что такое вебхук? Как работают вебхуки sona.to

Что такое вебхук? Это сообщение, которое одно приложение отправляет другому в момент, когда что-то происходит, чтобы второму приложению не приходилось постоянно спрашивать. Вы даёте первому приложению адрес, и оно отправляет туда данные о каждом событии сразу, как только оно произошло. В этом руководстве объясняется, как работают вебхуки, как проверить, что вебхук настоящий, и что отправляет sona.to; кратко это описано и на странице вебхуков.

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

Большинство приложений обмениваются данными двумя способами. С API ваша система спрашивает: «пост уже опубликован?» и, если ответ «нет», спрашивает позже снова. С вебхуком приложение само сообщает вам: когда пост опубликован, оно отправляет запрос на выбранный вами адрес с данными поста.

Таким образом, вебхук представляет собой HTTP-запрос, обычно POST с телом в формате JSON, который отправляется на URL под вашим контролем. Этим URL может быть ваш собственный сервер или адрес вебхука, выданный n8n, Zapier, Make, Slack или другим сервисом, который запускает сценарий при получении запроса.

Вебхук и API: в чём разница

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

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

Любой, кто знает адрес вашего вебхука, может отправить на него поддельный запрос, поэтому хорошо сделанный вебхук подписывается. Отправитель вычисляет подпись по телу запроса и общему секрету, обычно с помощью HMAC SHA-256, и кладёт её в заголовок. Ваша сторона вычисляет такую же подпись с тем же секретом и сравнивает их сравнением с постоянным временем. Если они не совпадают, запрос игнорируется.

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

Вебхуки в sona.to

sona.to отправляет вебхуки для четырёх событий: пост опубликован, публикация поста не удалась, аудит сайта завершён и аудит сайта завершился ошибкой. Вы выбираете, какие события получает каждый вебхук, так что бот уведомлений в чате может получать только ошибки, а таблица отчёта получает всё. Полезная нагрузка использует те же названия полей, что и API sona.to.

Настройка. На странице API в панели управления вставьте адрес, отметьте события и сохраните. Секрет для подписи показывается один раз, в этот момент, поэтому скопируйте его сразу.

Подпись. Каждая доставка несёт заголовок с меткой времени и HMAC SHA-256 от метки времени и тела, созданным с вашим секретом. Отклоняйте запросы, метка времени которых старше нескольких минут.

Повторы. Если ваш адрес недоступен или возвращает ошибку, доставка повторяется через 60 секунд, 5 минут и 30 минут. Каждая попытка записывается в журнал с кодом статуса и длительностью. Адрес, который продолжает выдавать ошибки, отключается, и после исправления его можно включить снова.

Безопасность. Адрес должен использовать https и вести на публичный сервер. Адреса в частных сетях отклоняются при сохранении и ещё раз при доставке, а перенаправления не выполняются.

Вебхуки в n8n, Zapier и Make

В приложениях sona.to для n8n, Zapier и Make есть готовые триггеры для тех же четырёх событий, поэтому вставлять адрес самому не нужно: добавьте триггер, и приложение настроит вебхук. Подробнее об автоматизации соцсетей в n8n, Zapier и Make.

Все подробности, с примером проверки подписи, есть в документации API.

Частые вопросы

Вебхук и API это одно и то же?

Нет. API отвечает, когда вы спрашиваете. Вебхук присылает вам сообщение, когда что-то происходит.

Вебхуки sona.to бесплатные?

Вебхуки входят во все тарифы вместе с API.

Что будет, если мой сервер недоступен?

sona.to повторит попытку три раза примерно за полчаса. Если доставка по-прежнему не проходит, вебхук отключается, пока вы не включите его снова.