Часто потрібно здійснити інтеграцію EddyDesk зі сторонніми системами або, наприклад, налаштувати розсилку повідомлень. У нашій системі є потужне API, яке дозволяє обмінюватися інформацією із зовнішніми системами. Проте, часто необхідно з системи отримати інформацію щодо будь-якої події, наприклад, надіслати повідомлення при надходженні термінової заявки. Для цього EddyDesk вміє викликати webhook.
Вебхуки дозволяють сповіщати/викликати зовнішні системи про події в EddyDesk. З їхньою допомогою можна відправляти SMS повідомлення клієнтам/співробітникам, інтегруватися з CRM системою тощо.
Вебхуки знаходяться в диспетчері і є однією з його дій ("Надіслати вебхук"), це дозволяє гнучко настроїти відправку вебхуків за умов диспетчера.
При додаванні вебхука необхідно:
- Вибрати метод HTTP: GET, POST, PUT, PATCH, DELETE.
- Вказати посилання, куди буде надіслано запит. У засланні можна використовувати теги.
- Вказати формат даних, що надсилаються: JSON, XML, X-FORM-URLENCODED.
- Якщо потрібна авторизація, потрібно вибрати тип авторизації: ім'я користувача, пароль/API ключ.
- Сформувати запит із даними у вибраному форматі за допомогою тегів. У випадку X-FORM-URLENCODED, роздільником змінних необхідно використовувати “&”.
Якщо сервер, на який надсилається запит, відповідає HTTP кодом 2ХХ/3ХХ, запит вважається успішним, в іншому випадку, наприклад, якщо сервер недоступний, запит буде повторюватися кожні 30 хвилин протягом 24 годин.
Доступні такі методи авторизації:
Basic Authentication (Username:Password)
https://swagger.io/docs/specification/authentication/basic-authentication/
У налаштуваннях вебхука вказуємо Ім'я користувача та Пароль:
Bearer Authentication (Bearer Token)
https://swagger.io/docs/specification/authentication/bearer-authentication/
У налаштуваннях вказуємо Bearer токен:
При надсиланні веб-хука доступна опція обробки відповіді:
Дані можуть бути записані в індивідуальні або часові поля.
Розглянемо кілька прикладів:
- надсилання повідомлення співробітнику Telegram про надходження нового звернення;
- відправка СМС в SMSTraffic;
- підзаявка надсилає коментар до батьківської заявки після отримання відповіді
Необхідно використовувати наступну URL:
https://api.telegram.org/bot*/sendMessage, де * - ключ бота (API Token).
"chat_id":* відповідає за ID користувача (співробітника), якому буде надіслано повідомлення про надходження заявки.
Щоб дізнатися id, необхідно спочатку написати з Telegram облікового запису потрібного користувача в систему, після чого переглянути цю інформацію в його картці користувача і вставити її в саме правило:
Або ж дізнатися id можна, наприклад, звернувшись до Telegram-боту @myidbot:
Для надсилання смс через даний сервіс необхідно налаштувати вебхук запитом без авторизації, вказавши такі параметри:
- POST https://api.smstraffic.ru/multi.php?login=mylogin&password=mypassword&phones=78001234567&message=test где:
- login - Ваш логiн в SMSTraffic (у прикладі mylogin);
- password - пароль в SMSTraffic (у прикладі mypassword);
- phones = номер телефону;
- message - текст смс повідомлення (test).
При успішному надсиланні вебхука в коментарі буде відображено інформацію:
поле URL: https://eguzkia.helpdeskeddy.com/api/v2/tickets/{parent_ticket_id}/comments/ , де
https://eguzkia.helpdeskeddy.com - адреса Вашої системи.
Ім'я користувача та пароль для стандартної авторизації необхідно скопіювати в розділі "Глобальні налаштування", поле API ключ, до: (двокрапки) ім'я користувача - електронна поштова адреса, після: (двокрапки) пароль.
Можна додати обмеження на відправлення коментаря в батьківську заявку тільки якщо відповідь у підзаявку надійшла з боку клієнта. Для цього в Додаткових умовах необхідно вибрати умову (через "і") - Автор останньої відповіді.
У батьківській заявці з'явиться повідомлення у коментарі:
Приклад оповіщення зовнішніх систем про події в EddyDesk:
Якщо Ви не знаєте як зробити необхідну інтеграцію, сміливо звертайтеся до нас - з радістю допоможемо!