Веб-хуки

Веб-хук – это механизм, позволяющий одному приложению уведомлять другое приложение о наступлении определенных событий в реальном времени. По сути, это автоматизированное сообщение, отправляемое из одного сервиса в другой, когда происходит что-то важное.

 

Список веб-хуков

Для создания и редактирования веб-хуков необходимо перейти в раздел События – Веб-хуки.

 

 

На текущей закладке отображается список веб-хуков и набор инструментов для работы со списком:

Ÿ  Поисковая строка – обеспечивает поиск необходимого веб-хука;

Ÿ   – включает/выключает отображение идентификаторов веб-хуков;

Ÿ  Добавить веб-хук – открывает форму для создания нового веб-хука;

Ÿ   – позволяет просмотреть информацию о веб‑хуке и при необходимости внести изменения;

Ÿ   – удаляет веб-хук.

Создание веб-хука

Для создания нового веб-хука, необходимо нажать на кнопку Добавить веб-хук

 

В открывшейся форме заполняются следующие реквизиты:

• Название – текстовое поле для ввода названия веб‑хука. Используется для идентификации веб-хука в системе, помогает пользователю найти и управлять конкретным веб-хуком;
• Тип веб-хука – определяет протокол, по которому будет отправляться запрос веб-хука. Выбирается необходимый из выпадающего списка, по умолчанию установлено значение HTTP;

Метод запроса – определяет HTTP-метод, который будет использоваться для отправки запроса на указанный URL. Выбирается необходимый из выпадающего списка, по умолчанию установлено значение POST;

• Адрес запроса – текстовое поле для ввода URL‑адреса. Конечная точка (URL) внешнего сервиса, куда будет отправлен веб-хук при наступлении события;
• Заголовки запроса – используются для передачи дополнительной информации о запросе. Это может быть:

-       авторизация (например, Authorization: Bearer <токен> для аутентификации запроса);

-       тип контента (например, Content-Type: application/json для указания формата тела запроса);

-       пользовательские заголовки – любые другие метаданные, которые могут потребоваться принимающему сервису.

Заголовки запроса содержат поля:

-       Ключ;

-       Значение.

С помощью соответствующих кнопок можно добавлять дополнительные или удалять ненужные поля;

• Query параметры – добавляются к URL после знака вопроса «?» и используются для передачи небольших порций данных, которые не являются частью тела запроса. Содержат поля:

-       Ключ;

-       Значение.

С помощью соответствующих кнопок можно добавлять дополнительные или удалять ненужные поля;

• Тело запроса – многострочное текстовое поле с подсказкой «JSON». Здесь указываются данные, которые будут отправлены в теле HTTP-запроса. Для веб-хуков это обычно данные о событии, которое произошло;
• Количество попыток повтора – числовое поле, определяет сколько раз система будет пытаться отправить веб-хук, если первая попытка завершится неудачей (например, из-за ошибки сети или недоступности принимающего сервиса);
• Время ожидания между попытками (мс) – числовое поле в миллисекундах (мс). Указывает интервал времени, который система будет ждать перед каждой следующей попыткой отправки веб‑хука;
• Максимальное время ожидания между попытками (мс) – числовое поле в миллисекундах (мс). Определяет максимальное время, которое система будет ждать между повторными попытками, если используется экспоненциальная задержка или другая стратегия увеличения интервала между попытками;
• Таймаут запроса (мс) – числовое поле в миллисекундах (мс). Определяет максимальное время, в течение которого система будет ждать ответ от принимающего сервиса на каждый отдельный запрос веб-хука. Если ответ не получен в течение этого времени, запрос считается неудачным;
• Асинхронный запрос – если этот флажок установлен, веб-хук будет отправлен асинхронно. Это означает, что основное приложение не будет ждать завершения отправки веб-хука, прежде чем продолжить свою работу.

 

Для сохранения изменений необходимо нажать на кнопку Добавить. После этого веб-хук будет создан в системе с указанными настройками и появится в общем списке.