Как создать веб-хук

Чтобы создать Веб-хук на сайте KOMPaaS, перейдите в раздел 'Интеграции' → вкладка 'Веб-хуки' и нажмите 'Новый веб-хук'.

В открывшемся модальном окне выберите тип события веб-хука и нажмите кнопку 'Создать'.

Заполните поля настройки веб-хука:

1. Название — название веб-хука;

2. URL — адрес, на который, будет отправляться веб-хук;

3. Повторять в случае ошибки — по умолчанию функция включена. при проставленной галочке, в случае ошибки при отправки веб-хука на заданный URL повторит его отправку (Рекомендуется оставлять эту функцию включённой).

4. Игнорирования отключения веб-хуков— функция будет отправлять веб-хук и по умолчанию будет считаться успешным, даже если он будет не успешным (url недоступен или другая ошибка). Рекомендуется тем, у кого долгое время ответа сервера.

   ⚠️Внимание! Функция доступна только пользователю с правами администратора.

   
   

5. Выберите метод — типы запроса GET или POST:

   • GET — запрос запрашивает данные с определенного ресурса (сайта);
   • POST — запрос отправляет данные на сервер для последующей их обработки;

6. Выберите тип данных — типы данных JSON или Text:

   • JSON — структура данных в формате JSON
   • Text — вольное заполнение. можно заполнить по своему усмотрению и под свои нужны в любом формате и любой структуре 

7. Доступные параметры — параметры, которые зависят от типа события. Доступные параметры можно добавлять в любое место настроек веб-хуков простым кликом по ним. 

8. Пользовательские параметры — дополнительные параметры которые добавятся в структуру JSON в дополнение к отмеченными галочками синими переменными выше.

9. Query параметры — параметры запроса URL (URL Query Parameters) являются дополнительной информацией, которую можно добавить в URL-адрес. Состоит из двух обязательных элементов - из самого параметра и его значения, разделенных знаком равенства (=).

   • Например: https://site.com/?first_parametr=first_value&second_parametr=second_value

10. Заголовки HTTP (HTTP Headers) — несколько строчек текста в определенном формате, которые либо уточняют запрос, либо описывают содержимое тела сообщения. 

11. После заполнения параметров нажмите кнопку «Сохранить».

Более подробней о типах запросов см.:

«Веб-хуки»

«POST запрос» 

«GET запрос»

«Типы событий веб-хуков»