REST Активити: Вебхуки


Действие позволяет выполнить запрос на сторонний адрес, выбрав HTTP-метод, формат передачи данных, параметры, заголовки и авторизацию запроса.


Важно: для предотвращения злоупотреблений запросы разрешены только на одобренные адреса. Если нужный сайт отсутствует в списке разрешенных, обратитесь в поддержку IT-Solution.


Запрос на сторонний сервер выполняется от лица приложения REST Активити: с IP-адреса 94.26.246.180, домен restactivity.it-solution.ru. Если ранее настроенный Вебхук перестал работать, проверьте вкладки Очередь запросов и Статистика запросов. В базовой версии приложения доступно 3000 запросов в месяц.


Способ передачи данных для авторизации зависит от внешнего сервиса. API-ключ или Bearer-токен чаще всего передается в заголовках, но некоторые сервисы ожидают его в теле запроса или в URL. При заполнении полей ориентируйтесь на документацию сервиса, с которым настраивается интеграция.



С чего начать

Подготовьте URL, HTTP-метод, формат данных, параметры, заголовки и пример ответа внешнего сервиса. Затем откройте конструктор бизнес-процесса, разверните Действия приложений и добавьте [REST Активити Б24] Вебхук.


Поля активити блока

Название поля Что значит
Пользовательское название Название блока, под которым его результаты будут отображаться в следующих действиях.
URL Полный адрес, на который будет отправлен запрос.
HTTP-метод Операция, которую нужно выполнить: GET — получить данные; POST — отправить данные; PUT — создать или заменить; PATCH — изменить часть данных; DELETE — удалить.
Формат отправки данных FormData передает пары «ключ — значение»; application/json передает JSON; Отправить как есть не преобразует содержимое.
Данные Данные для POST, PUT или PATCH. При GET поле игнорируется. Тело DELETE может быть проигнорировано или обрезано принимающим сервером.
HTTP-авторизация Basic HTTP-авторизация в формате username:password.
Заголовки запроса Дополнительные заголовки. Каждый заголовок указывается с новой строки. API-ключи и токены передавайте так, как требует документация внешнего сервиса.
JSONPath Путь к нужному значению в JSON-ответе. Используется только если сервер вернул JSON. Если добавить несколько JSONPath, их результаты будут доступны отдельно.
Пользователь для отладки Пользователь, который будет получать отладочные уведомления.
Запускать от имени
Пользователь, в контексте которого выполняется действие.



Пример заполнения

Для безопасной проверки можно выполнить GET-запрос без данных CRM:

URL: https://httpbin.org/get?source=restactivity_docs
HTTP-метод: GET
Формат отправки данных: [не установлено]
Данные: [пусто]
Заголовки: User-Agent: ITSolution-bitrix24/1.0
JSONPath: $.args.source


Ожидаемый результат: restactivity_docs.

pasted-image.png


Использование результатов работы активити

Результаты доступны в следующих действиях через раздел дополнительных результатов:


Результат — результаты JSONPath;

Ошибки выполнения запроса — сведения об ошибке;

time_execute — время выполнения запроса;

Статус ответа — статус, который вернул сервер;

Результат только для выбранного JSONPath — отдельный результат, если селекторов несколько;

Таймаут операции — признак превышения времени ожидания.

Доп.результаты


Комментарии

Теги: rest activity