Вебхуки
Вебхук — це спосіб повідомити іншу програму, що в Smengo щось сталося: опублікували графік, змінили зміну, співробітник відмітив прихід, менеджер вирішив заявку на заміну. Щойно це стається, Smengo сам надсилає повідомлення на вказану вами адресу. Іншій програмі не потрібно постійно запитувати «а чи не змінилося щось» — вона дізнається одразу.
Налаштування потрібне, лише якщо у вас є зовнішня система, яка має реагувати на зміни: власна облікова програма, панель звітів, чат-бот, автоматизація. Зазвичай адресу для вебхука дає розробник або підрядник, який цю систему налаштовує.
Хто може налаштувати
Розділ доступний учаснику з правом «Налаштування організації» — зазвичай це власник. Знайти його можна в «Налаштування» → «Інтеграції» → блок «Вебхуки».
Події, які ви можете обрати, обмежені вашими правами: якщо ви не бачите відміток приходу та виходу в самому Smengo, надсилати їх назовні теж не можна — такі пункти будуть недоступні.
Як додати вебхук
- Натисніть «Додати вебхук».
- Вставте адресу приймача — її дає той, хто налаштовує вашу зовнішню систему. Адреса має починатися з
https://. - Позначте події, про які потрібно повідомляти:
- Графік опубліковано — менеджер опублікував місяць.
- Зміну змінено — зміну створили, змінили або видалили.
- Відмітка приходу або виходу — співробітник відмітився у боті.
- Рішення щодо заміни — менеджер схвалив або відхилив заявку.
- За бажанням додайте опис — він лише для вас (наприклад, «звіти в BI»).
- Натисніть «Додати».
Збережіть секрет — він показується один раз
Одразу після додавання на екрані з'явиться секрет — рядок, що починається з whsec_. Ним підписується кожне повідомлення: за ним приймальна сторона переконується, що лист справді від Smengo, а не від стороннього.
Скопіюйте секрет і передайте розробнику захищеним каналом, перш ніж закрити вікно. Удруге переглянути його не можна. Якщо секрет загубився — натисніть «Змінити секрет» і передайте новий: добу після зміни працюють обидва, тож нічого не зламається.
Перевірте, що все працює
Кнопка «Надіслати тестову» надсилає на вашу адресу пробне повідомлення і одразу показує, що відповів ваш сервер. Якщо відповідь успішна — усе налаштовано правильно. Якщо ні, покажіть відповідь розробнику: у ній написано, що пішло не так.
Нижче, у блоці «Останні доставки», видно 25 останніх відправлень: час, подія, відповідь вашого сервера і саме повідомлення. Це перше місце, куди варто зазирнути, якщо у зовнішній системі чогось бракує.
Пауза та видалення
- Пауза — тимчасово припинити надсилання. Поки вебхук на паузі, події не накопичуються: після відновлення надійде лише те, що станеться далі.
- Видалити — прибрати адресу зовсім, разом із журналом відправлень.
Що робити, якщо надійшов лист про вимкнення
Якщо ваша адреса не відповідає успішно приблизно добу, Smengo припиняє спроби й вимикає вебхук, а вам надходить лист. Те саме написано в картці вебхука — червоним банером.
Що робити по порядку:
- Покажіть лист розробнику або перевірте самі, чи працює приймальна програма.
- Коли полагодите — натисніть «Надіслати тестову» і переконайтеся, що відповідь успішна.
- Увімкніть вебхук назад кнопкою «Відновити».
Події, що накопичилися за час вимкнення, повторно не надсилаються — потрібні дані зовнішня система може дочитати через API. Окремий лист надходить і тоді, коли ваш сервер прямо відповів «такої адреси більше немає»: тоді потрібна нова адреса.
Чим вебхуки відрізняються від API-ключа
- API-ключ — зовнішня система сама запитує дані, коли їй потрібно.
- Вебхук — Smengo сам повідомляє про зміну, щойно вона сталася.
Зазвичай їх використовують разом: вебхук каже «щось змінилося», а подробиці програма дочитує за API-ключем.
Для розробників
Технічні деталі — формат повідомлення, заголовки, перевірка підпису, розклад повторів — у документації щодо вебхуків. Це посилання можна передати тому, хто налаштовує приймання.