Огляд вебхуків

Загальна інформація про вебхуки та навіщо вони потрібні.
Написано Микола
Оновлено 2 місяці тому

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

Іншими словами, HelpCrunch виступає як постачальник вебхуку, який надсилає оновлення в режимі реального часу, щойно вони відбуваються, тому вам не потрібно постійно викликати наш REST API, щоб перевірити, чи відбулися якісь зміни у ваших контактах або чатах.

Вебхуки можуть різко зменшити кількість запитів GET до REST API, що допоможе вам завжди залишатися в межах лімітів API.

Технічно оновлення в режимі реального часу — це запити HTTP POST, які надсилаються на вашу загальнодоступну URL-адресу (кінцеву точку).

Щоб отримувати такі оновлення в режимі реального часу, вам слід налаштувати вебхуки у своєму обліковому записі HelpCrunch, підписатися на відповідні події (events) та обробляти запити вебхуку у вашій програмі.

Коли використовувати вебхуки

Скажімо, у вас є власна CRM-система, і ви хочете, щоб усі нові контакти негайно додавались до CRM, коли вони починають новий чат з вашою командою за допомогою віджета HelpCrunch.

  • Поганий варіант – щогодини викликати наш метод REST API "Отримати всі контакти" і перевіряти, чи є нові контакти, але це не буде в режимі реального часу і взагалі не працюватиме, якщо у вас велика клієнтська база, оскільки цей метод дозволяє отримати не більше 100 контакти за один запит. Це змусить вас швидко перевищити обмеження REST API, і деякий час ви не зможете надсилати інші додаткові запити.
  • Хороший варіант — налаштувати вебхук, який ініціює подію (event), коли до вашого облікового запису HelpCrunch додається новий контакт. Потім ви можете обробити цей запит на своєму сервері, витягти всю необхідну інформацію про контакт та додати її до CRM.
Якщо ви не знайдете якісь дані про контакт в тілі запиту вебхука, ви можете скористатися методом REST API "Отримати інформацію про контакт", щоб отримати всю інформацію про цей контакт.

Щоб синхронізувати ті самі дані контакту, коли деяка інформація змінюється у вашій CRM, ви можете використовувати метод REST API "Оновити контакт". Вебхуки в цьому випадку не працюватимуть, оскільки вони дозволяють лише отримувати дані з вашого облікового запису HelpCrunch, але не оновлювати їх.

Чи була наша стаття корисною?