Настройка исходящего запроса (webhook)
Исходящий запрос используется, чтобы передать данные о произошедшем событии из одной системы в другую.
Разберем составляющие HTTP Запроса.
Метод – наиболее распространенными методами являются GET и POST, также для выбора доступны PUT и DELETE.
URL – адрес на который будет отправлен запрос с данными.
Заголовки – могут содержать информацию об авторизации пользователя, например, идентификатор сессии или токены доступа. Определяют параметры передачи, такие как кодировка, размер данных, способ сжатия и т.д.
Тело запроса – здесь передается информация о самом событии. Данные всегда представляют собой пары из «ключа» (имя поля) и «значения» (его содержимое).
URL – адрес на который будет отправлен запрос с данными.
Заголовки – могут содержать информацию об авторизации пользователя, например, идентификатор сессии или токены доступа. Определяют параметры передачи, такие как кодировка, размер данных, способ сжатия и т.д.
Тело запроса – здесь передается информация о самом событии. Данные всегда представляют собой пары из «ключа» (имя поля) и «значения» (его содержимое).
Пример с простым объектом. Указываем ключ=значение, каждый ключ указываем с новой строки. Для того чтобы в значение подставить переменную используем двойные фигурные скобки {{переменная}}.
В итоге тело запроса будет выглядеть так:
{
"name": "Имя",
"telephone": "79998888888"
}
Пример объекта с вложенным объектом. Указываем путь к нужным ключам каждый с новой строчки.
В итоге тело запроса будет выглядеть так:
{
"contact": {
"name": "Имя",
"phone": "79991234567"
}
}
Пример объекта с вложенным массивом и объектами.
В итоге тело запроса будет выглядеть так:
{
"contacts": [
{
"name": "Имя",
"phone": "79991234567"
},
{
"name": "Клиент",
"phone": "79001234567"
}
]
}
Создание процесса
Для примера создадим процесс в котором при создании нового лида будет отправляться исходящий запрос в котором мы отправим смс сообщение клиенту с использованием API сервиса smsgorod.ru.
Чтобы создать процесс откройте раздел «Ещё» — «Процессы» и нажмите кнопку «Создать»
В открывшемся окне выберем событие "Лид: Добавление". Поля "Источник" и "Город" выступают в качестве условий. Например, выбрав источник "Сайт" и город "Краснодар", процесс будет запущен при условии, что у добавленного лида в качестве источника указан сайт, а в качестве города указан Краснодар.
Выбираем действие Исходящий запрос (webhook) и заполняем форму согласно API сервиса smsgorod.ru
В итоге после создания нового лида в смс сервис будет отправлен запрос:
{
"apiKey": "AbCd**********",
"sms": [
{
"channel": "digit",
"text": "Здравствуйте, ваша заявка принята в работу с вами свяжутся в ближайшее время",
"phone": "79001234567"
}
]
}
Переменные в теле запроса
Лиды
| {{name}} | Имя |
| {{phone}} | Телефон |
| {{email}} | Email |
| {{cost}} | Сумма |
Сделки
| {{name}} | Имя |
| {{phone}} | Телефон |
| {{email}} | Email |
| {{cost}} | Сумма |