Вебхуки
Вебхук — это способ сообщить другой программе, что в Smengo что-то произошло: опубликовали график, изменили смену, сотрудник отметил приход, менеджер решил заявку на замену. Как только это случается, Smengo сам отправляет сообщение по указанному вами адресу. Другой программе не нужно постоянно спрашивать «а не изменилось ли что-нибудь» — она узнаёт сразу.
Настройка нужна, только если у вас есть внешняя система, которая должна реагировать на изменения: своя учётная программа, панель отчётов, чат-бот, автоматизация. Обычно адрес для вебхука даёт разработчик или подрядчик, который эту систему настраивает.
Кто может настроить
Раздел доступен участнику с правом «Настройки организации» — обычно это владелец. Найти его можно в «Настройки» → «Интеграции» → блок «Вебхуки».
События, которые вы можете выбрать, ограничены вашими правами: если вы не видите отметки прихода и ухода в самом Smengo, отправлять их наружу тоже нельзя — такие пункты будут недоступны.
Как добавить вебхук
- Нажмите «Добавить вебхук».
- Вставьте адрес приёмника — его даёт тот, кто настраивает вашу внешнюю систему. Адрес должен начинаться с
https://. - Отметьте события, о которых нужно сообщать:
- График опубликован — менеджер опубликовал месяц.
- Смена изменилась — смену создали, изменили или удалили.
- Отметка прихода или ухода — сотрудник отметился в боте.
- Решение по замене — менеджер одобрил или отклонил заявку.
- При желании добавьте описание — оно только для вас (например, «отчёты в BI»).
- Нажмите «Добавить».
Сохраните секрет — он показывается один раз
Сразу после добавления на экране появится секрет — строка, которая начинается с whsec_. Им подписывается каждое сообщение: по нему принимающая сторона убеждается, что письмо действительно от Smengo, а не от постороннего.
Скопируйте секрет и передайте разработчику по защищённому каналу, прежде чем закрыть окно. Второй раз посмотреть его нельзя. Если секрет потерялся — нажмите «Сменить секрет» и передайте новый: сутки после смены работают оба, так что ничего не сломается.
Проверьте, что всё работает
Кнопка «Отправить тестовое» отправляет на ваш адрес пробное сообщение и сразу показывает, что ответил ваш сервер. Если ответ успешный — всё настроено верно. Если нет, покажите ответ разработчику: в нём написано, что пошло не так.
Ниже, в блоке «Последние доставки», видно 25 последних отправок: время, событие, ответ вашего сервера и само сообщение. Это первое место, куда стоит заглянуть, если во внешней системе чего-то не хватает.
Пауза и удаление
- Пауза — временно перестать отправлять. Пока вебхук на паузе, события не копятся: после возобновления придёт только то, что произойдёт дальше.
- Удалить — убрать адрес совсем, вместе с журналом отправок.
Что делать, если пришло письмо об отключении
Если ваш адрес не отвечает успешно примерно сутки, Smengo прекращает попытки и отключает вебхук, а вам приходит письмо. То же самое написано в карточке вебхука — красным баннером.
Что делать по порядку:
- Покажите письмо разработчику или проверьте сами, работает ли принимающая программа.
- Когда почините — нажмите «Отправить тестовое» и убедитесь, что ответ успешный.
- Включите вебхук обратно кнопкой «Возобновить».
События, накопившиеся за время отключения, повторно не отправляются — недостающие данные внешняя система может дочитать через API. Отдельное письмо приходит и в случае, когда ваш сервер прямо ответил «такого адреса больше нет»: тогда нужен новый адрес.
Чем вебхуки отличаются от API-ключа
- API-ключ — внешняя система сама спрашивает данные, когда ей нужно.
- Вебхук — Smengo сам сообщает об изменении, как только оно произошло.
Обычно их используют вместе: вебхук говорит «что-то изменилось», а подробности программа дочитывает по API-ключу.
Для разработчиков
Технические детали — формат сообщения, заголовки, проверка подписи, расписание повторов — в документации по вебхукам. Эту ссылку можно передать тому, кто настраивает приём.