Webhook — это механизм оповещения системы о событиях. Когда происходит событие, сервер посылает post-запрос по адресу, который указан в webhook-URL.
В платформе BotHelp вы можете настроить интеграции с другими платформами через webhook.
Формат webhook
Каждый webhook — это http post-запрос на URL, который вы указали. Тело запроса содержит данные в формате JSON.
Webhook BotHelp отправляется с http-заголовком Content-Type: application/ json, поэтому убедитесь, что ваш сервис может обрабатывать такие запросы.
Типы событий
События в ботах
Событие в многошаговом боте происходит, когда подписчик доходит до шага, где прописан webhook. В линейном боте это происходит, когда подписчик прошёл бота до конца.
Подробнее о том, какие данные передаются из бота, читайте в статье: Отправка webhook.
События в чатах
Для чатов есть 2 типа событий: ConversationClosed и UserProfileViewed. Эти события никак не связаны с автоворонками, происходят они в разделе «Диалоги».
Подробнее о данных из этих событий читайте в статье: Chat Webhook reference.
Вы можете самостоятельно настроить webhook или использовать специальные платформы-интеграторы. В нашей базе знаний есть несколько инструкций об использовании этих платформ. Ищите их в соответствующем разделе: Интеграции.
Вопрос. Может ли BotHelp принимать данные из других платформ?
Ответ. Да, используйте для этого открытый API BotHelp. Подробная инструкция в нашей статье: API BotHelp.
Отправка webhook
Вы можете связать BotHelp и любую платформу, используя передачу данных по webhook. Для этого вставьте webhook-URL в соответствующее поле в боте.
Как добавить отправку по webhook?
Многошаговый бот
- Создайте новое действие.
- Добавьте действие «Отправить данные подписчика через webhook».
- Вставьте ссылку на webhook в поле.
- Сохраните действие.
Через webhook передадутся данные, которые были у пользователя в профиле в момент, когда он проходил этого бота.
Какие данные передаются?
- Дата создания профиля подписчика.
- Имя (полное, только имя, только фамилия).
- Ссылка на профиль.
- Дата первого и последнего диалога.
- ID подписчика в мессенджере (в том числе юзернейм пользователя Telegram).
- ID подписчика в кабинете BotHelp.
- CUID — уникальный ID для интеграций с GetCourse/Bizon365.
- UTM-метки.
- Все поля и их значения.
{
//Standard fields
«created_at»: 1499947711, //timestamp
«name»: «John Wick»,
«first_name»: «John»,
«last_name»: «Wick»,
«profile_link»: «https:\/\/fb.com\/1941325716136721»,
«email»: «[email protected]»,
«phone»: «+14123456789»,
«conversations_count»: 10,
«first_contact_at»: 1499944111,
«last_contact_at»: 1499944111,
«user_id»: «1234567890»,
«bothelp_user_id»: «47659»,
«created_at_show»: «14/07/2017 07:56:32 UTC» //time and date of creating a lead for humans,
«cuid»: «1et0.301»
//Custom fields
«utm_source»: «VK»,
«utm_campaign»: «messenger»,
«utm_medium»: «social_cpc»,
«utm_content»: «123»
«age»: «21»,
«position»: «CEO at Pinapple»,
}
Где взять webhook-URL?
Если ваш программист настраивает получение webhook, он сообщит адрес, на который его нужно отправить. Если вы используете специальные сервисы-интеграторы, они предоставят вам URL на одном из этапов настройки.
У нас есть инструкции по настройке интеграции через сервисы:
Воспользуйтесь ими, чтобы интегрироваться с нужной вам платформой. Список доступных для интеграции платформ ищите на сайтах интеграторов.
Если вы не нашли ответ на свой вопрос, задайте его нам в чате внутри кабинета либо напишите на [email protected] 😃
Получите 14 дней полного функционала платформы для создания рассылок, автоворонок и чат-ботов BotHelp.