Webhook (вебхук) – это механизм оповещения одной системы о событиях в другой. Блок «Отправка webhook» используется для отправки запросов webhook на сторонний сервис. Например, вебхук может прямо в процессе диалога с клиентом создать сделку или изменить поле в карточке CRM.
Чтобы отправить запрос webhook:
1. В Редакторе сценариев добавьте блок «Отправка webhook» в рабочую область.
2. В поле «URL адрес» укажите ссылку — ее нужно получить в сервисе, куда будет отправлен запрос.
Важно: Ссылка должна начинаться с https://
2. Выберите тип запроса в первой вкладке:
- GET — запрашивает представление ресурса. Запросы с использованием этого метода могут только извлекать данные;
- POST — используется для отправки сущностей к определённому ресурсу. Часто вызывает изменение состояния или какие-то побочные эффекты на сервере;
- PUT — заменяет все текущие представления ресурса данными запроса;
- PATCH — используется для частичного изменения ресурса;
- DELETE — удаляет указанный ресурс.
3. Добавьте хедеры и параметры во вкладках Headers и Params. Они отличаются в зависимости от сервиса. Подробнее о формировании запроса можно ознакомиться в разделе документации «REST API» выбранного сервиса.
- Чтобы добавить хедеры, введите ключи и значения:
- После добавления нажмите «Сохранить».
- Чтобы добавить параметры, так же введите ключи и значения, сохраните изменения.
- В значениях хедеров и параметров в тексте можно использовать переменные — их нужно добавлять в кавычках.
Пример тела запроса в формате json:
{
"params": {
"chat_id": {{id_chat}},
"context_id": 1,
"messenger_type": "{{messenger_type}}"
}
}
4. У блока есть результат «error_message» — в него пишется ошибка, если переменные добавлены некорректно.
Пример настройки сценария с участием этого блока доступен в статье «Webhook Битрикс24».
Видеоурок
Если у вас остались вопросы, мы сделали видеоурок о блоке Отправка webhook.