Як налаштувати вихідні webhooks у Xcellerate OPS

Xcellerate OPS створює подію щоразу, коли щось відбувається: створено тікет, прийнято комерційну пропозицію, створено рахунок, пропущено дзвінок. За допомогою вихідних webhooks ви надсилаєте ці події у форматі JSON на власний URL, щоб Zapier, Make, n8n, Power Automate або ваша система одразу на них реагували. Цей посібник для адміністраторів MSP і сервісних компаній, які хочуть, щоб OPS керував іншими їхніми інструментами.

TL;DR

• Відкрийте Settings → Data and security (Дані та безпека) → Notifications and webhooks (Сповіщення та webhooks) і додайте по одному URL для кожної події.
• OPS одразу надсилає один JSON POST на кожну подію, за бажанням підписаний HMAC-SHA256.
• Кожна доставка надсилається один раз, без повторних спроб: оберіть отримувача, який завжди доступний і швидко відповідає.

Перш ніж почати

• Ви маєте роль admin у своєму робочому просторі OPS.
• У вас є endpoint, який приймає запити POST з Content-Type: application/json і відповідає протягом 8 секунд.
• URL вказує на публічну адресу. Приватні або внутрішні адреси відхиляються. Бажано використовувати HTTPS.
• За бажанням: спільний секрет, за яким отримувач перевіряє підпис.

Налаштування вихідного webhook

Крок 1: Відкрийте сторінку подій

Перейдіть до Settings → Data and security (Дані та безпека) → Notifications and webhooks (Сповіщення та webhooks). Події згруповано за напрямами. Їхні назви показано англійською разом із технічним ключем, наприклад «Ticket created» (ticket.created).

Сторінка Notifications and webhooks з параметрами для кожної події: сповіщення виконавця, лист клієнту, шаблон листа та кнопка додавання webhook.

Крок 2: Додайте webhook до події

Знайдіть подію, яку хочете пересилати, і натисніть Add webhook (Додати webhook). Введіть URL отримувача.

Крок 3: Задайте секрет підпису (за бажанням)

Заповніть поле Signing secret (optional) (Секрет підпису, необов'язково). Тоді кожен запит міститиме заголовок X-Signature: sha256=<hex>: HMAC-SHA256 від сирого JSON-тіла, обчислений з вашим секретом. Отримувач обчислює те саме значення і порівнює. Після збереження секрет більше не показується. Якщо під час збереження залишити поле порожнім, збережений секрет залишиться без змін.

Крок 4: Надішліть тест

Натисніть Test (Тест), щоб надіслати приклад payload для цієї події. Тест підтверджує лише те, що OPS зміг надіслати запит. Він не показує, що ваш endpoint із ним зробив. Тому завжди перевіряйте на боці отримувача, в історії чи журналах вашого інструмента, що приклад надійшов і був правильно оброблений.

Крок 5: Збережіть і повторіть

Натисніть Save (Зберегти) у верхній частині сторінки. Повторіть для кожної події, яку хочете пересилати: ви задаєте один URL для кожного типу подій.

Що відбувається після підключення

• Напрямок: з OPS на ваш URL. Один POST на подію, надісланий у момент, коли вона відбувається.
• Вміст: кожне повідомлення має однакову структуру. Поле data відрізняється залежно від події.

{
  "event": "ticket.created",
  "label": "Ticket created",
  "occurredAt": "<ISO-8601>",
  "title": "…",
  "link": "/tickets/…",
  "data": { … }
}

• Охоплення: понад 160 типів подій, зокрема тікети, клієнти й контакти, завдання CRM, проєкти, бюджети, табелі, рахунки, договори, комерційні пропозиції, активи, дзвінки, угоди, робочий час, ITIL changes, problems та incidents, а також AI-колеги.
• Сповіщення: на цій самій сторінці для кожної події налаштовуються сповіщення в застосунку, Notify assignee (Сповістити виконавця) і шаблони листів клієнтам для подій тікетів.

Дізнайтеся більше про автоматизацію в OPS та інтеграції ЄС і безпеку.

Корисно знати

• Надсилається один раз, без повторів. Немає повторних спроб і журналу доставки. Якщо отримувач недоступний або надто повільний, подія не надійде. Використовуйте надійного отримувача: платформу автоматизації або власний endpoint, який зберігає повідомлення, одразу відповідає й обробляє його пізніше.
• Тайм-аут 8 секунд, переспрямування не виконуються. Використовуйте кінцевий URL.
• Один URL на тип події. Якщо ту саму подію мають отримати кілька систем, нехай ваш отримувач розподіляє її далі.
• Масовий імпорт і об'єднання записів ніколи не запускають webhooks.
• Під час надсилання URL повторно перевіряється на публічну адресу.

Усунення проблем

• «Sample payload sent.» Тестовий запит надіслано. Перевірте в отримувача, що його також оброблено.
• «Webhook test failed: » Помилка на рівні з'єднання, наприклад DNS, тайм-аут або TLS.
• Помилка перевірки під час збереження. URL недійсний або вказує на приватну чи внутрішню адресу.
• Реальні події не надходять, хоча тест пройшов. Перевірте, що endpoint відповідає швидко, без переспрямування, і досі доступний за публічною адресою.

Почніть

Хочете, щоб OPS передавав тікети, пропозиції та рахунки іншим вашим інструментам? Почніть безкоштовно і налаштуйте перший webhook у налаштуваннях.