Webhook

Коннектор для обработки входщих HTTP запросов

Коннектор предназначен для обработки входящих запросов от внешних систем по протоколу HTTPS. Данный коннектор поддерживает следующие методы: GET, POST, PUT, DELETE.

Доступ к параметрам запроса

Доступ к параметрам запроса может быть осуществлен через данные в контексте ctx.data

Название	Описание
ctx.data.params	This property is an object containing properties mapped to the named route “parameters”. For example, if you have the route /user/:name, then the “name” property is available as req.params.name. This object defaults to {}.
ctx.data.headers	Объект, который содержит заголовки запроса, переданные клиентом.
ctx.data.query	This property is an object containing a property for each query string parameter in the route. If there is no query string, it is the empty object, {}.
ctx.data.body	Contains key-value pairs of data submitted in the request body. (application/json, application/x-www-form-urlencoded)
ctx.data.user	Если в настройках коннектора выбран тип авторизации OIDC, то при успешной аутентификации данный объект будет содержать пользователя OIDC.

Данные запроса также будут скопированы в исходящую схему и могут быть переданыследующим коннекторам через объект result

Название	Тип	Описание
result.headers	Object	Объект, который содержит заголовки запроса, переданные клиентом.
result.params	Object	This property is an object containing properties mapped to the named route “parameters”. For example, if you have the route /user/:name, then the “name” property is available as req.params.name. This object defaults to {}.
result.query	Object	This property is an object containing a property for each query string parameter in the route. If there is no query string, it is the empty object, {}.
result.body	Object	Contains key-value pairs of data submitted in the request body. (application/json, application/x-www-form-urlencoded)
result.user	Object	Если в настройках коннектора выбран тип авторизации OIDC, то при успешной аутентификации данный объект будет содержать пользователя OIDC.

Настройки коннектора

Коннектор в качестве настроек принимает следующие параметры:

• Method - метод HTTP запроса, поддерживаются (GET, POST, PUT, DELETE)

• Endpoint - статическая и динамическая часть URL, например: /users или /users/:id

• Authentication - тип авторизации (None, Basic, Oidc)

• Username - имя пользователя для Basic авторизации

• Password - пароль пользователя для Basic авторизации

Пример использования коннектора

Ниже приведен пример вебхука, который при GET запросе будет отдавать некий html код.

Настройки коннектора буду иметь значения, приведенные на скриншоте ниже, также для ответа клиенту на запрос используется метод ctx.response.render, который вызывает рендеринг шаблона.

Настройки коннектора вебхука

Добавим шаблон в процесс, который будет использоваться в нашем вебхуке. Мы используем готовый коннектор шаблона EJS

Настройки коннектора шаблона

Общий вид процесса

После запуска процесса и обращения в браузере к вебхуку по адресу: https://api.mixapp.io/webhooks/runexis/5cc068cc574e7400014ac011/index?name=John%20Smith будет отображена следующая страница: