Елемент Вебхук в чат-ботах

Доступно на платному тарифі, а також на час безплатного семиденного пробного періоду

Ви можете налаштувати відправку вебхука за сценарієм ланцюжка вашого чат-бота або активувати глобальні вебхуки за різними подіями вашого чат-бота та отримувати інформацію у своїй системі.

Розглянемо, що таке вебхуки та де вони використовуються, а також як їх активувати і яка структура даних, що одержуються.

Зміст

Де використовуються вебхуки

Вебхук — механізм оповіщення про події за допомогою надсилання HTTP запиту на URL-адресу, де знаходиться обробник.

За допомогою цієї інтеграції ви зможете налаштувати надсилання даних про подію в ланцюжку бота у свою систему для подальшої роботи з цим клієнтом.

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

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

Як увімкнути відправку вебхука в ланцюжку

Ви можете додати вебхук у конструкторі ланцюжка та відстежувати певну інформацію з проходженням потрібних вам блоків ланцюжка.

Повідомлення	Введення користувачем своїх даних або натискання на створену кнопку.
Дія	Відкриття чату з адміністратором, відписка від бота, оновлення змінної, присвоєння тега.
Ланцюжок	Запуск нового ланцюжка.
Пауза	Завершення часу паузи.
Фільтр	Проходження виставлених умов фільтра.
Запит API	Отримання інформації на запит.

Щоб вставити відправлення вебхука, додайте блок «Дія» після блоку, що відстежується.

Виберіть опцію «Надіслати вебхук» (Send webhook). Введіть назву вебхука та URL, що відправляється, куди передавати дані.

Як увімкнути глобальні вебхуки

Ви можете також підключити вебхуки, які будуть відправлятися за подіями всього чат-бота.

Перейдіть до налаштувань бота, у вкладку «Вебхуки» (Webhooks). Активуйте налаштування та вставте URL-адресу, на яку потрібно надсилати дані.

Виберіть події, за якими потрібно надсилати оповіщення, і натисніть «Зберегти» (Save), щоб застосувати установки.

Ви можете вибрати наступні події:

Підписка на бот	Надсилається з інформацією про користувачів, коли користувач підписався на вибраного чат-бота.
Вхідні повідомлення	Надсилається при кожному новому повідомленні від користувача в чаті з інформацією про користувача та текстом повідомлення.
Вихідні повідомлення	Надсилається при кожному надісланому повідомленні користувачеві з інформацією про користувача та текстом повідомлення.
Відкриття чату	Відправляється після проходження користувачем ланцюжка з дією з інформацією про користувача.
Старт користувальницького ланцюжка	Відправляється при запуску тригерних ланцюжків з інформацією про користувача і ланцюжок.
Перехід за посиланням	Надсилається при проході користувачем за посиланнями в кнопках і тексті з інформацією про посилання, що відправляє блок і користувач.
Відписка від бота	Відправляється при відписці користувача від бота з інформацією про користувача та бота.
Заблокував бота	Відправляється при блокуванні користувачем повідомлень від бота з інформацією про користувача та бота.

Ви також можете увімкнути відстеження оплати в чат-ботах у налаштуваннях облікового запису. Читайте докладніше: «Як відправити вебхук про успішну оплату».

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

Вебхук передає такі дані:

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

Приклад вебхука чат-бота, що відправляється з ланцюжка:

[
    {
        "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",
            "last_message": "hey! whats up?", // останнє повідомлення користувача
            "photo": "https://.. ",
            "tags": ["назва тега 1", "назва тега 2"],
            "id": "467bf50f-9cb0-4b65-b722-0135ad5fb9e0", // ідентифікатор контакту в Sendpulse
            "name": "
        Alexander,
        "date": 1617401679 // дата спрацьовування блоку в мілісекундах
    }
]

Приклад вебхука для «Підписка на бота»:

[
   {
      "info":null,
      "service":"telegram",
      "title":"new_subscriber",
      "bot":{
         "url":"https://t .me/best_bot",
         "external_id":1845120800,
         "id":"60b0a854b4d8073f592b92f3",
         "name":"BEST"
      },
      "contact":{
         "username":"veronica",
         "name"
         "tags":[
            
         ],
         "last_message":"Test",
         "photo":null,
         "variables":{
            "name":"Veronica Petrova",
            "Phone":"380985236985",         
            "Email":"test@gmail.com"
         } ,
         "id":"60b0a854083b4964fd0f7b657847848"
      },
      "date":16377590567070
   }
]

Приклад вебхука для «Вхідні повідомлення»:

[
   {
      "info":{ // інформація з месенджера
         "message": {
            "channel_data": {
               "message": {
                  "audio":null,
                  "from":1332678955,
                  "context":null,
                  "interactive":null,
                  "contacts":null,
                  "text":{
                     "body":"hey! whats up?"
                  },
                  "button":null,
                  "system":null,
                  "voice":null,
                  "video":null,
                  "identity":null,
                  "image":null,
                  "timestamp":1625834714,
                  "document":null,
                  "type":"text",
                  "id":"ABCDOAk1346346go-sKd--dduwQ9p",
                  "sticker":null,
                  "location":null
               },
               message_id":"ABCDOAk1Z43535-sKd
            "
            --dduwQ9":"60e8434b446846838d8463"
         }
      },
      "service":"whatsapp",
      "title":"incoming_message",
      "bot":{
         "url":"https://wa.me/380932674329",
         "external_id" 380932674329",
         "id":"60c1c50c156845831909cf74",
         "name":"Revision_me"
      },
      "contact":{
         "username":"Alexander",
         "name":"Alexander",
         "tags"
            
         ],
         "last_message":"hey! whats up?", // останнє повідомлення користувача
         "photo":null,
         "variables":{
            "dept":"Designer"
         },
         "id":"60c0f31f457479d02b7512"
      },
      "date":1625834714
   }
]

Приклад вебхука для «Вихідні повідомлення»:

[
   {
      "info":{
         "message":{
            "channel_data":{
               "message":{
                  "disable_web_page_preview":null,
                  "text":"Click",
                  "disable_notification":null,
                  "reply_to_message_id":null,
                  "parse_mode":"HTML",
                  "reply_markup":{
                     "inline_keyboard":[
                        [
                           {
                              "payload_id":"84d30d5624-92245695-4e834560-86f4-bbdb694710b0456",
                              "callback_data":"eyJwIjoiODRkMzBkMjQtOTI5NS00ZTgwLTg2ZjQtYmJkYjY5NDcxMGIwIn05257 ",
                              "text":"Click",
                              "data":{
                                 "to_block_id":"3bd58f77-ef28-4f0d-9ae7-33ef71bedeb85724",
                                 "to_block":1,
                                 "button_id":"6cb63b34-a030 8f13320ad36b3687568"
                              },
                              "type":"postback",
                              "statistic_id-a030-4e53-ba91-8f13320ad36b5367637",
                              "external_id":
                              "6cb63b34"503 -a030-4e53-ba91-8f13320ad36467346b"
                           }
                        ],
                        [
                           {
                              "payload_id":"97867499-063c-498d-9386
                              """
                              "",
                              e26284addf1da-{
                                 "to_block_id":"9ba1c058-7ae8-429d-9d83-f674bf6635685b 2f8",
                                 "to_block":null,
                                 "button_id-42a6-9448-e47875b4663568999"
                              },
                              "type":"postback"
                              ",edef
                              "external_id-aa26-8331a013568dfabc",
                              ":bc769bd8-edef-
                           "
                        -
                     4
                  0dc7-4bb9
               id
               642a6-9448",4
               "6:4
            e47875b46568586999
            "id":"619e3686cac8ab43e20a4a0546549"
         }
      },
      "service":"telegram",
      "title":"outgoing_message",
      "bot":{
         "url":"https://t.me/best_bot",
         "external_id" :"18451208006576",
         "id":"60b0a854b4d8073f592b925675f3",
         "name":"BEST"
      },
      "contact":{
         "username":"veronica",
         "name":"veronica
         ","
            
         ],
         "last_message":"Test",
         "photo":null,
         "variables":{
            "name":"Veronica Petrova",
            "Phone":"380985236985",         
            "Email":"test@gmail.com"
         } ,
         "id":"60b0a854083b4964fd0f7b65675675"
      },
      "date":16377585936738
   }
]

Приклад вебхука для «Відкриття чату»:

[
   {
      "info":null,
      "service":"telegram",
      "title":"open_chat",
      "bot":{
         "url":"https://t. me/best_bot",
         external_id":18451208007356,
         "id":"60b0a854b4d8073f592b92f673563",
         name""BEST"
      },
      "contact":{
         "username":
         """
         :tags":[
            
         ],
         "last_message":"Test",
         "photo":null,
         "variables":{
            "name":"Veronica Petrova",
            "Phone":"380985236985",         
            "Email":"test@gmail.com"
         } ,
         "id":"60b0a854083b4964fd0f756756b65"
      },
      "date":16377587917546
   }
]

Приклад вебхука для «Старт користувальницького ланцюжка»:

[
   {
      "info":null,
      "service":"telegram",
      "title":"run_custom_flow",
      "bot":{
         "url":"https://t .me/best_bot",
         external_id":1845120856756700,
         "id60b0a854b4d8073f592b92f3564567",
         ":"BEST"
      },
      "contact":{
         "username"
         ""name
         "tags":[
            
         ],
         "last_message":"Test",
         "photo":null,
         "variables":{
            "name":"Veronica Petrova",
            "Phone":"380985236985",         
            "Email":"test@gmail.com"
         } ,
         "id":"60b0a854083b4964fd0f7b655858"
      },
      "date":163775889778478
   }
]

Приклад вебхука для «Перехід за посиланням»:

[
   {
      "info":null,
      "service":"telegram",
      "title":"link_click",
      "bot":{
         "url":"https://t .me/best_bot",
         external_id":1845120806750,
         "id":"60b0a854b4d8073f592b9254677654f3",
         ":"BEST"
      },
      "contact":{
         "username":
         ""name
         "tags":[
            
         ],
         "last_message":"Test",
         "photo":null,
         "variables":{
            "name":"Veronica Petrova",
            "Phone":"380985236985",         
            "Email":"test@gmail.com"
         } ,
         "id":"60b0a854083b4964fd0f65757b65"
      },
      "date":16377589785675
   }
]

Приклад вебхука для «Відписка від бота»:

[
   {
      "info":null,
      "service":"telegram",
      "title":"unsubscribe",
      "bot":{
         "url":"https://t .me/best_bot",
         "external_id":1845120806780,
         "id":"60b0a854b4d8073f592b92678f3",
         "name:"BEST"
      },
      "contact":{
         "username":
         "veronica"
         "tags":[
            
         ],
         "last_message":"Test",
         "photo":null,
         "variables":{
            "name":"Veronica Petrova",
            "Phone":"380985236985",         
            "Email":"test@gmail.com"
         } ,
         "id":"60b0a854083b4966784fd0f7b65"
      },
      "date":1637759687101
   }
]

Приклад вебхука для «Заблокував бота»:

[
   {
      "info":null,
      "service":"telegram",
      "title":"bot_block",
      "bot":{
         "url": "https://t. me/best_bot",
         "external_id":1845126570800,
         "id":"60b0a854b4d8056773f592b92f3",
         "name":"BEST"
      },
      "contact":{
         "username":"
         "veronica,
         "tags":[
            
         ],
         "last_message":"Test",
         "photo":null,
         "variables":{
            "name":"Veronica Petrova",
            "Phone":"380985236985",         
            "Email":"test@gmail.com"
         } ,
         "id":"60b0a854083b4964fd5670f7b65"
      },
      "date":1637756579166
   }
]

Дані вебхука надходять з типом application/json.

Оновлено: 25.03.2024

Оцініть, наскільки стаття була корисною "Елемент Вебхук в чат-ботах"

Оцінка: 5 / 5

Елемент Вебхук в чат-ботах

Зміст

Де використовуються вебхуки

Як увімкнути відправку вебхука в ланцюжку

Як увімкнути глобальні вебхуки

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

Спробуйте бота для розсилок в Facebook Messenger безкоштовно