Webhook – механізм сповіщень системи та/або сторонніх систем про події телефонії або Віртуальної АТС Ringostat у певний момент.
У разі виникнення події, створеної раніше в ЛК, webhook-обробник відправляє HTTP-запит з набором параметрів на URL, який був вказаний для цього Webhook`а.
Якщо URL, на який надсилається Webhook, недоступний (відповідає не HTTP 200 OK), спроб повторного відправлення Webhook на цю URL до очікуваного 200 ОК не буде. Webhook буде відзначено "з помилкою", його статус відправки та помилку можна буде переглянути на сторінці Перевірка помилок Webhooks
WebHooks — спрощений варіант rest-подій та rest-команд, що не вимагає написання програми. Але, навіть незважаючи на це, робота з REST - це непросте завдання, яке вимагає солідної кваліфікації від розробника.
Подія - “Вхідний дзвінок”
перед дзвінком;
після дзвінка;
після меню оцінки дзвінка;
у момент підняття трубки;
в момент переадресації.
Подія – “Вихідний дзвінок”
перед дзвінком;
після дзвінка.
Подія - “Надсилання форми з сайту”
Подія - “Відкриття/закриття діалогу”
Старт діалогу у месенджері;
Завершення діалогу у месенджері.
Подія - “Угода створена або її статус оновлено”
Створення webhook-запиту
В особистому кабінеті перейдіть до розділу Інтеграція, потім на сторінку Webhooks. Сторінка містить таблицю активних та налаштованих інтеграцій проекту. За замовченням, додано та налаштовано подію Після дзвінка з webhook для Google Analytics, який не можна редагувати
Унікальна подія та новий webhook-запит.
Щоб створити новий webhook-запит із новим видом події:
1. Натисніть Додати подію:
Після натискання на кнопку відкриється меню з налаштуваннями для обробника.
2. Заповніть поля для нової події:
У Назва вкажіть назву події (наприклад, Перед дзвінками, якщо тип події відповідний)
3. Виберіть саму подію зі списку
4. Додаємо параметри для нової дії (Webhook-запиту):
Напрямок – адреса обробника, на яку буде надіслано запит. Стандартні порти: 80 для HTTP та 443 для HTTPS. Для встановлення Webhook на URL із зазначеним портом можна передавати URL у вигляді: http://11.111.111.11:80
Заголовки – автоматично проставляються заголовки Content-Type, залежно від методів надсилання. Можна редагувати або видалити заголовок.
Метод надсилання даних:
GET – запит із передачею параметрів в адресному рядку (URL-адреса запиту);
POST – запит із передачею параметрів у тілі (body) запиту;
PUT – запит для зміни екземпляра із зазначеним ID.
Формат надсилання даних – формат переданих даних на обробник запиту.
json – відправка параметрів у форматі об'єкта (набір пар ключ/значення) у запиті;
raw - дозволяє передавати дані у запиті без будь-якої обробки або кодування у певному форматі, наприклад, текстовому, бінарному або у вигляді зображення;
Json-rpc - це протокол віддаленого виклику процедур, який використовує формат JSON для передачі запитів і відповідей між клієнтом і сервером, визначаючи структуру запитів і відповідей у вигляді об'єктів з обов'язковими полями "jsonrpc", "method" і "params";
Form - дозволяє передавати дані у запиті у вигляді URL-кодованих пар ключ/значення у тілі запиту, зазвичай використовується для надсилання даних із форм на веб-сторінках.
Формат дати - за замовчуванням, стоїть Стандартна дата.
Типи параметрів:
Текст - текстовий інпут, з списку можна вибрати потрібний вам параметр;
Масив - поле стає мультиселектом, тобто можна додати кілька параметрів та передати їх у масиві;
Об'єкт - можна додати набір полів і передавати дані в об'єкті. Всередині об'єктів є можливість додавати об'єкти та масиви, якщо треба задати декілька рівнів вкладеності для об'єктів.
md5/crc32/sha1/sha256 hash - це різні алгоритми хешування, які використовуються для перетворення даних у фіксовану довгу послідовність символів (хеш), яка може бути використана для перевірки цілісності даних та захисту від несанкціонованого доступу.
Нова подія з дією (webhook-запитом) створена:
Копіювання webhook-запиту
Якщо вебхук вже створено, але вам потрібно створити ще один такий же webhook-запит із незначними змінами, наприклад, в такому випадку:
1. Натисніть на три крапки навпроти події, що існує та скопіюйте її:
2. Оберіть тип події та натисніть "Далі"
3. Скопійовану подію треба зберегти
4. Новостворену подію можна редагувати nа внести зміни в поля
Також, ви можете побачити приклад вебхуку, що буде надіслано, або тестово відправити його. Внизу, після заповнення всіх параметрів буде два варіанти під кнопкою "Preview": "Show sample" та "Execute and show sample" відповідно.
Де будуть вказані всі дані та тіло запиту:
Важливо! Назва параметра має бути латиницею та без пробілів, інакше не буде коректної передачі даних. Якщо потрібно назву параметра тільки кирилицею та/або з пробілами, у такому разі її слід записати у фігурних дужках. Наприклад: {{назва параметра}}
На цьому створення webhook-запиту завершено.