Вебхуки (webhooks)

Часто требуется осуществить интеграцию HelpDeskEddy со сторонними системами либо, к примеру, настроить рассылку уведомлений. В нашей системе присутствует мощное API, которое позволяет обмениваться информацией с внешними системами. Однако, зачастую необходимо из системы получить информацию по какому-либо событию, например, отправить уведомление при поступлении срочной заявки. Для этого HelpDeskEddy умеет вызывать webhook.

 

Вебхуки позволяют оповещать/вызывать внешние системы о событиях в HelpDeskEddy. С их помощью можно отправлять SMS уведомления клиентам/сотрудникам, интегрироваться с CRM системой и так далее.

Вебхуки находятся в диспетчере и являются одним из его действий ("Отправить вебхук"), это позволяет гибко настроить отправку вебхуков при помощи условий диспетчера.

При добавлении вебхука необходимо:

  • Выбрать HTTP метод: GET, POST, PUT, PATCH, DELETE.
  • Указать ссылку, куда будет отправлен запрос. В ссылке можно использовать теги.
  • Указать формат отправляемых данных: JSON, XML, X-FORM-URLENCODED.
  • Если необходима авторизация, то нужно выбрать тип авторизации: имя пользователя, пароль/API ключ.
  • Сформировать запрос с данными в выбранном формате используя теги. В случае X-FORM-URLENCODED, разделителем для переменных необходимо использовать “&”.

Если сервер, на который отправляется запрос, отвечает HTTP кодом 2ХХ/3ХХ, то запрос считается успешным, в другом случае, например, если сервер недоступен, запрос будет повторяться примерно каждые 30 минут от 3 до 5 попыток.

 

Доступны следующие методы авторизации:

 

1) Стандартная авторизация

Basic Authentication (Username:Password)

https://swagger.io/docs/specification/authentication/basic-authentication/ 

 

В настройках вебхука указываем Имя пользователя и Пароль:

f0753016fc93d0a4651c354d866e5ba938fde2b2

 

2) Авторизация используя API ключ

Bearer Authentication (Bearer Token)

https://swagger.io/docs/specification/authentication/bearer-authentication/ 

 

В настройках указываем Bearer токен:

ab428e16799b104bcf6901e544fe87fcd9df1b41

 

При отправке вебхука доступна опция обработки ответа:

 

Данные могут быть записаны в индивидуальные или во временные поля.

 

Рассмотрим несколько примеров:

 

Пример вебхука для отправки уведомления сотруднику в Telegram при поступлении новой заявки

 

 

Необходимо использовать следующий URL:

https://api.telegram.org/bot*/sendMessage, где * - ключ бота (API Token). 

 

"chat_id":* отвечает за id пользователя (сотрудника), которому будет отправлено уведомление о поступлении заявки.

Чтобы узнать id, необходимо сначала написать с Telegram аккаунта нужного пользователя в систему, после чего просмотреть эту информацию в его карточке пользователя и вставить её в само правило:

 

 

Или же узнать id можно, например, обратившись к Telegram-боту @myidbot:

 

Отправка СМС в SMS Traffic

 

Для отправки смс через данный сервис необходимо настроить вебхук запросом без авторизации, указав следующие параметры:

 

При успешной отправке вебхука в комментарии будет отображена информация:

 

Подзаявка отправляет комментарий в родительскую заявку после получения ответа

 

 

поле URL: https://eguzkia.helpdeskeddy.com/api/v2/tickets/{parent_ticket_id}/comments/ , где

https://eguzkia.helpdeskeddy.com - адрес Вашей системы.

Имя пользователя и пароль для стандартной авторизации необходимо скопировать в разделе "Глобальные настройки", поле API ключ, до : (двоеточия) имя пользователя - электронный почтовый адрес, после : (двоеточия) пароль.

Можно добавить ограничение на отправку комментария в родительскую заявку только если ответ в подзаявку поступил со стороны клиента. Для этого в Дополнительных условиях необходимо выбрать условие (через "и") - Автор последнего ответа.

 

В родительской заявке отобразится сообщение в комментарии:

 

Пример оповещения внешних систем о событиях в HelpDeskEddy:

 

В случае если Вы не знаете как совершить необходимую интеграцию, смело обращайтесь к нам - с радостью поможем!