Обработка webhooks Bpium в Oktell — различия между версиями

Версия 13:53, 15 июля 2016

Наверх

Введение

В Бипиум существует возможность отправки уведомлений сторонним системам при изменении данных пользователями. Для отправки уведомлений сторонние системы должны быть подписаны на события - вебхуки(webhooks). Подробнее с настройкой вебхуков в Бипиум можно ознакомиться здесь http://docs.bpium.ru/webhooks.html.

В данной статье рассматривается способ приема таких уведомлений в Oktell.

Бипиум отправляет события на указанный при создании webhook адрес при помощи POST-запроса с передачей сообщения о событии в теле запроса в формате JSON.

Принять и обработать POST-запрос с произвольным содержимым в Oktell можно при помощи служебного сценария генерации 404 ошибки. Он запускается когда на web-сервер Oktell приходит запрос на неизвестный ресурс. В качестве входных параметров в сценарий передаются: адрес ресурса, HTTP-заголовки запроса, содержимое запроса.

Таким образом получаем следующий алгоритм обработки вебхуков:

• создаем вебхук и указываем адрес для запросов в Oktell
• настраиваем служебный сценарий генерации 404 ошибки, в котором анализируем адрес, на который пришел запрос
• обрабатываем содержимое запроса и выполняем необходимые действия в Oktell

Пример

Рассмотрим простой пример: В Бипиум настроен каталог Задачи. При добавлении новой задачи и назначении ответственного, ему необходимо отправить уведомление на электронную почту.

Каталог Задачи содержит 3 поля: Название задачи, Описание и Ответственный.

Настроим вебхук, укажем адрес web-сервера Oktell, на который будут отправляться уведомления - https://user:password@myoktell.ru/Bpium/NewTask.

Создадим служебный сценарий HTTP404. Сохраняем в переменные адрес ресурса и содержимое значение функций Входной параметр 1 и Входной параметр 4, которые содержат соответственно адрес ресурса и содержимое запроса.

Анализируем адрес ресурса: если переменная содержит строку “/Bpium/NewTask”, то продолжаем обработку запроса, в противном случае завершаем сценарий. Обработку содержимого будем производить в отдельном служебном сценарии BpiumNewTask, который запустим асинхронно. Основной сценарий завершаем установкой кода ответа HTTP 200 в служебную переменную (сл) Возвращаемое значение 2.

В сценарии обработки содержимого запроса BpiumNewTask с помощью компонента Парсер разбираем полученное JSON-сообщение. Подробнее о работе с компонентом Парсер можно прочитать в статье компонент Парсер. Выделяем из полученного сообщения Название задачи, Описание задачи и идентификатор ответственного. Далее при помощи компонента Bpium получаем адрес электронной почты ответственного. Формируем текст письма и отправляем ответственному сотруднику.

Указываем в настройках web-сервера Oktell созданный сценарий.

Добавляем новую запись в каталог Задачи, получаем уведомление на электронную почту.

Скачать архив со сценариями