Как да настроите изходящи 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 и за EU интеграциите и сигурността.

Добре е да знаете

• Изпраща се веднъж, без повторен опит. Няма retry и няма журнал на доставките. Ако получателят не е достъпен или е твърде бавен, събитието не пристига. Използвайте надежден получател: платформа за автоматизация или собствен endpoint, който запазва съобщението, отговаря веднага и го обработва след това.
• Изчакване до 8 секунди, пренасочвания не се следват. Използвайте крайния URL.
• Един URL за тип събитие. Ако няколко системи трябва да получат едно и също събитие, нека получателят го разпредели.
• Масовите импорти и сливанията никога не задействат webhooks.
• При изпращане URL адресът се проверява отново за публичен адрес.

Отстраняване на проблеми

• „Sample payload sent.“ Тестовата заявка е изпратена. Проверете при получателя дали е и обработена.
• „Webhook test failed: “ Грешка на ниво връзка, например DNS, изтекло време или TLS.
• Грешка при валидиране при запазване. URL адресът е невалиден или сочи към частен или вътрешен адрес.
• Реалните събития не пристигат, въпреки че тестът е минал. Проверете дали endpoint-ът отговаря бързо, без пренасочване, и все още е достъпен на публичен адрес.

Започнете

Искате OPS да предава тикетите, предложенията и фактурите ви на останалите ви инструменти? Започнете безплатно и настройте първия си webhook от настройките.