Входящий Вебхук
Last updated
Last updated
Входящий вебхук позволяет из внешнего сервиса запускать сценарий бота для конкретного контакта и передавать в него параметры.
Для создания вебхука необходимо выполнить следующие действия:
Создать сценарий в разделе "Сценарии", который будет вызываться с помощью вебхука
Создать вебхук в разделе "Входящие вебхуки"
Указать произвольное имя
Выбрать сценарий, созданный на шаге №1
Настроить сопоставление переменных, передаваемых в теле запроса, с переменными бота, которые будут записываться при вызове вебхука. Все переменные в теле запроса вебхука должны быть переданы внутри переменной variables. Если у бота ещё нет переменной с заданным именем, она будет создана.
После создания вебхука, будет сгенерирован уникальный URL для запуска выбранного ранее сценария.
Для вызова вебхука можно использовать как POST так и GET запрос, переменные будут считаны вне зависимости от того, как они были переданы: в адресе или в теле запроса.
При вызове URL вебхука необходимо выполнить следующие условия:
Заголовок запроса (HTTP Headers) Accept должен иметь значение "application/json"
В переменных запроса должна присутствовать переменная признака поиска контакта contact_by с любым значением из списка ниже и переменная search со значением по которому необходимо найти контакт:
id - поиск контакта по его идентификатору в системе Leadteh,
phone - поиск по номеру телефона,
email - поиск по E-mail,
telegram_name - поиск по имени Telegram аккаунта,
telegram_id - поиск по числовому Telegram идентификатору,
whatsapp - поиск по номеру Whatsapp,
vk - поиск по Vk идентификатору,
viber - поиск по Viber идентификатору,
amocrm_id - поиск по идентификатору в системе AmoCRM,
bitrix24_id - поиск по идентификатору в системе Битрикс24
Пример GET запроса с поиском по номеру телефона:
Пример GET запроса с поиском по id контакта:
Пример тела POST запроса с передаваемыми переменными и поиском по id контакта:
Каждый вызов с переданными параметрами можно посмотреть на вкладке "История вызовов".
Срок хранения истории вызовов составляет 10 дней.