Как настроить отправку вебхука в чат-ботах

Вебхук — механизм оповещения о событиях посредством отправки HTTP запроса на URL, где находится обработчик.

С помощью этой интеграции вы сможете настроить отправку данных о событии в цепочке бота в свою систему для дальнейшей работы с этим клиентом.

Представьте сценарий: вы создали последовательный опрос для пользователя, чтобы он мог зарегистрироваться на мероприятие в мессенджере. Вам нужно узнать о новом зарегистрированном на определенную лекцию, чтобы связаться с ним или изменить статус в вашей CRM.

Именно с помощью добавленного вебхука вы можете это сделать. Как только пользователь проходит отслеживаемый блок настроенной цепочки, в вашу систему отправляются данные о свершившемся событии.

Как включить отправку вебхука

Добавьте блок «Действие» после отслеживающевого блока. Выберите опцию «Отправить вебхук». Введите название отправляемого вебхука и ссылку куда передавать данные.

Отслеживать можно такие события:

• в блоке «Сообщение» — введение пользователем своих данных или нажатие на созданную кнопку;
• в блоке «Действие» — открытие чата с администратором, отписку от бота, обновление переменной, присвоение тега.

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

Структура вебхука

Вебхук передает такие данные:

• дата срабатывания вебхука;
• название вебхука — по "title" вы можете на своей стороне фильтровать пришедшие вебхуки;
• информация о боте и к какой странице соцсети он подключен — идентификатор, фото и ссылка на страницу сообщества в соцсети;
• информация о контакте для которого произошло событие — идентификатор, имя, день рождения, город, страна, фото профиля, установленные переменные и теги.

Пример тела отправляемого POST запроса в JSON:

[
    {
        "info": null,
        "service": "messenger", // messenger - чат-бот Facebook Messenger, telegram - чат-бот Telegram, vk - чат-бот ВКонтакте
        "title": "Зарегистрировались. Зеленый зал", //название вебхука
        "bot": {
            "url": "https://m.me/104117781360763",
            "external_id": "104117781360763", // идентификатор сообщества в мессенджере (для Facebook значение передается строкой, для Telegram и ВКонтакте числом).
            "id": "17ff4105-d5f1-4790-9d09-a6f64ea73d54", // идентификатор подключенного бота в Sendpulse
            "name": "BEST" // название сообщества
        },
        "contact": {
           "имя переменной": "значение переменной", 
            "email": "name@example.com",
            "phone": "+38093000000",
            "photo": "https://..",
            "tags":  ["название тега 1", "название тега 2"],
            "id": "467bf50f-9cb0-4b65-b722-0135ad5fb9e0", // идентификатор контакта в Sendpulse
            "name": "Alexander"
        },
        "date": 1617401679 // дата срабатывания блока в милисекундах
    }
]

Данные вебхука приходят с типом application/json.

Обновлено: 05.04.2021