Керування вебхуками

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

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

Створення вебхука

1. Відкрийте Налаштування → Для розробників → Вебхуки
2. Натисніть Створити вебхук

3. Введіть URL, на яку надходитимуть події. Це має бути загальнодоступна кінцева точка HTTPS
4. Необов’язково: додайте Опис, щоб пізніше легко впізнати вебхук
5. Виберіть Події, на які потрібно підписатися. Стандартно вибрано всі три
6. Натисніть Створити

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

Доступні події

• conversation.ready: транскрипт і ШІ-аналіз готові, їх можна отримати
• conversation.failed: не вдалося обробити зустріч або файл
• conversation.deleted: зустріч або файл видалено

Дані кожної події містять ідентифікатор події, тип події та посилання на розмову. Повну схему даних, формат заголовка з підписом і приклад коду перевірки наведено в документації вебхуків.

Події та автоматизації

Кінцева точка на цій сторінці може отримувати два різні типи даних, і варто розуміти, що саме ви налаштовуєте.

Події повідомляють, що щось сталося. conversation.ready містить ідентифікатор, назву й стан, а ваш сервер потім сам отримує з API потрібний вміст.

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

Кінцева точка, яку використовують лише автоматизації, не підписана на жодну подію, тож на цій сторінці в неї не буде вибрано жодної події. Так і має бути.

Відстеження доставок

Натисніть будь-який вебхук, щоб відкрити сторінку його відомостей.

На сторінці відомостей показано:

• Стан і URL-адресу вгорі, а також перемикач, щоб призупинити доставки
• Секрет підпису: натисніть Показати, щоб побачити його, або Копіювати, щоб скопіювати
• Статистику за 24 години: кількість доставок, частку помилок, середній час відповіді та активність
• Останні доставки: по одному рядку на кожну спробу доставки. Натисніть рядок, щоб побачити тіло запиту й відповідь вашого сервера

Klang повторює невдалу доставку до шести разів, щоразу чекаючи довше, загалом протягом приблизно семи годин. Вебхук автоматично призупиняється, якщо п’ять доставок поспіль не вдалися, а збої тривають щонайменше добу. Короткий збій його не вимкне. Виправте кінцеву точку, а потім знову ввімкніть Отримання подій.

Надсилання тестової події

Щоб перевірити, чи працює кінцева точка:

1. Відкрийте сторінку відомостей вебхука
2. Натисніть Надіслати тестову подію у верхньому правому куті
3. Якщо вебхук підписано на кілька подій, виберіть, яку надіслати
4. Перевірте, що в розділі Останні доставки з’явився новий рядок

Тестові події позначено тегом TEST, а їхні ідентифікатори починаються з evt_test_. Схема даних така сама, як у справжньої події, тож ви можете перевірити свій обробник від початку до кінця.

Призупинення або видалення вебхука

На сторінці відомостей вебхука:

• Щоб призупинити вебхук, вимкніть Отримання подій. Klang перестане надсилати події, але збереже вебхук та його історію
• Щоб видалити вебхук, натисніть Редагувати, а потім Видалити вебхук унизу діалогового вікна

Призупинити або видалити вебхук можна також через меню … у списку вебхуків.

Що далі

• Ознайомтеся з документацією вебхуків, щоб дізнатися про схеми даних і перевірку підпису
• Керуйте інтеграціями, щоб натомість надсилати події через вбудовані сервіси, як-от Slack