Вебхуки доставляють події ідентифікації на ваш сервер у реальному часі. Щоразу,
коли відвідувача ідентифіковано, TRACIO надсилає HTTP-запит POST на налаштовану
вами URL-адресу вебхука. Тіло запиту і є корисним навантаженням події — жодної
обгортки-конверта немає.
Тіло — це плаский JSON-документ у camelCase. Це курована публічна підмножина
внутрішньої події — без хешів відбитків (fingerprint) чи внутрішніх маркерів
виявлення.
{ "requestId": "1710432000_abc123def", "phase": "primary", "visitorId": "X7fh2Hg9LkMn3pQr", "linkedId": "user_12345", "tag": "login", "timestamp": "2024-03-12T16:00:00Z", "url": "https://your-app.com/login", "ip": "94.142.239.124", "userAgent": "Mozilla/5.0 …", "browser": { "name": "Chrome", "version": "120.0" }, "os": { "name": "macOS", "version": "14.3" }, "device": "desktop", "geo": { "country": "CZ", "city": "Prague", "lat": 50.05, "lon": 14.4, "timezone": "Europe/Prague", "isp": "Example ISP" }, "network": { "vpn": false, "proxy": false, "tor": false, "datacenter": false, "connectionType": "residential" }, "bot": { "result": "human", "type": "", "score": 0.02 }, "identification": { "confidence": 0.95, "incognito": false, "visitType": "returning" }, "decision": { "action": "allow", "riskScore": 4, "suspectScore": 0.08 }}| Field | Type | Description |
|---|---|---|
requestId | string | Унікальний ідентифікатор події (також ключ ідемпотентності) |
phase | string | primary або late — див. нижче |
visitorId | string | Стабільний ідентифікатор відвідувача |
linkedId | string | Пов'язаний ідентифікатор, наданий клієнтом |
tag | string | Власний тег, наданий клієнтом |
timestamp | string | Час події (RFC 3339) |
url | string | URL-адреса сторінки, де було зафіксовано подію |
ip | string | IP-адреса клієнта |
userAgent | string | Необроблений рядок user-agent клієнта |
browser.name / .version | string | Виявлений браузер |
os.name / .version | string | Виявлена операційна система |
device | string | Клас пристрою (напр. desktop, mobile) |
geo | object | Геолокація за IP: country, city, lat, lon, timezone, isp |
network | object | vpn, proxy, tor, datacenter (булеві) та connectionType |
bot.result | string | human, bot або uncertain |
bot.type | string | Довільна мітка автоматизації, коли виявлено бота |
bot.score | number | Оцінка ймовірності бота |
identification.confidence | number | Впевненість моделі (0.0–1.0) |
identification.incognito | boolean | Контекст приватного/інкогніто перегляду |
identification.visitType | string | Класифікація візиту |
decision.action | string | Рекомендована дія |
decision.riskScore | number | Сукупна оцінка ризику (0–100) |
decision.suspectScore | number | Деталізована оцінка підозрілості |
phase розрізняє дві доставки, що мають однаковий requestId:
primary — надсилається одразу, щойно відвідувача ідентифіковано.late — подальша подія збагачення (уточнений вердикт щодо бота та
поведінкові сигнали, зафіксовані трохи пізніше).Співвідносьте обидві за requestId і розрізняйте їх за phase.
Кожна доставка містить заголовок X-Tracio-Signature:
X-Tracio-Signature: t=1710432000,v1=5257a869e7ecebed...t — це Unix-час (у секундах), коли запит було підписано.v1 — це HMAC-SHA256 у hex-кодуванні від "<t>.<rawRequestBody>", з ключем —
вашим секретом вебхука.Часова мітка є частиною підписаного вмісту, що дає захист від повторного
відтворення (replay) — перевіряйте проти необробленого Buffer тіла запиту
(не використовуйте розібраний/повторно серіалізований JSON, інакше підпис не
збігатиметься). Формуйте підписаний вміст як байти: префікс "<t>.",
конкатенований із буфером необробленого тіла, а потім рахуйте HMAC від цього.
// Express.js exampleimport express from "express"import crypto from "crypto"
const app = express()
// Capture the raw body so we can verify the signature byte-for-byte.app.use( express.json({ verify: (req, _res, buf) => { ;(req as any).rawBody = buf }, }),)
function verifySignature(rawBody: Buffer, header: string, secret: string): boolean { // Parse "t=...,v1=..." const parts = Object.fromEntries(header.split(",").map((kv) => kv.split("=") as [string, string])) const t = parts["t"] const v1 = parts["v1"] if (!t || !v1) return false
// Sign the raw bytes: "<t>." prefix + the raw request body buffer. const signed = Buffer.concat([Buffer.from(`${t}.`, "utf8"), rawBody]) const expected = crypto.createHmac("sha256", secret).update(signed).digest("hex")
const a = Buffer.from(v1, "hex") const b = Buffer.from(expected, "hex") return a.length === b.length && crypto.timingSafeEqual(a, b)}
app.post("/webhook/tracio", (req, res) => { const header = req.headers["x-tracio-signature"] as string if (!verifySignature((req as any).rawBody, header, WEBHOOK_SECRET)) { return res.status(401).json({ error: "Invalid signature" }) }
const event = req.body console.log(`Visitor: ${event.visitorId}`) console.log(`Bot: ${event.bot.result}`) // "human" | "bot" | "uncertain"
res.status(200).send("OK")})Ви також можете відхиляти доставки, чий t надто далекий від поточного часу
(наприклад, розбіжність понад п'ять хвилин), як додатковий захист від повторного
відтворення.
| Header | Description |
|---|---|
Content-Type | application/json |
X-Tracio-Signature | t=<unix>,v1=<hmac_sha256_hex> над "<t>.<rawBody>" |
X-Tracio-Event-Id | requestId події — використовуйте як ключ ідемпотентності |
X-Tracio-Webhook-Id | Ідентифікатор вебхука, що згенерував цю доставку |
Найпростіший спосіб керувати вебхуками — візуально в dashboard. Ними також
можна керувати програмно через management API з областю робочого простору
(workspace) — той самий API, який використовує dashboard. Він обслуговується на
хості застосунку (наприклад, https://app.tracio.ai/api/v1) і автентифікується
за допомогою JWT вашої сесії dashboard (Clerk); кожен запит додатково
перевіряється проти вашої ролі в робочому просторі (RBAC). Окремого секрету API
немає. Усі ендпоінти вебхуків розташовані під /workspaces/{workspaceId}.
curl -X POST https://app.tracio.ai/api/v1/workspaces/{workspaceId}/webhooks \ -H "Authorization: Bearer <clerk-session-jwt>" \ -H "Content-Type: application/json" \ -d '{ "url": "https://your-server.com/webhook/tracio", "events": [] }'Секрет для підпису генерується TRACIO й повертається один раз під час
створення (та під час ротації) у полі signingSecret. Зберігайте його надійно —
це ключ, який ви використовуєте для перевірки підписів.
{ "ok": true, "data": { "id": "wh_abc123", "workspaceEnvironmentId": "b201f2ba-…", "url": "https://your-server.com/webhook/tracio", "events": [], "signingSecret": "f3a9…<hex>", "status": "active", "successRate": 100, "createdAt": "2024-03-12T16:00:00Z" }}Під час наступних читань signingSecret маскується (null) — він розкривається
лише під час створення та ротації секрету.
| Method | Path | Description |
|---|---|---|
GET | /workspaces/{workspaceId}/webhooks | Список вебхуків |
PATCH | /workspaces/{workspaceId}/webhooks/{webhookId} | Оновити url / events / status |
DELETE | /workspaces/{workspaceId}/webhooks/{webhookId} | Видалити вебхук |
POST | /workspaces/{workspaceId}/webhooks/{webhookId}/test | Надіслати підписану тестову доставку |
POST | /workspaces/{workspaceId}/webhooks/{webhookId}/secret/rotate | Ротувати секрет для підпису |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | Список останніх спроб доставки |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | Список останніх спроб доставки |
Доставки можуть повторюватися, тож ваш обробник має бути ідемпотентним.
Дедуплікуйте за заголовком X-Tracio-Event-Id (тобто requestId):
app.post("/webhook/tracio", async (req, res) => { const eventId = req.headers["x-tracio-event-id"] as string
const existing = await db.webhooks.findOne({ eventId }) if (existing) return res.status(200).send("Already processed")
await db.webhooks.insert({ eventId, processedAt: new Date() }) await processWebhookEvent(req.body)
res.status(200).send("OK")})Повертайте відповідь 2xx якомога швидше й обробляйте корисне навантаження
асинхронно, щоб уникнути тайм-аутів. Відповіді, відмінні від 2xx (а також
помилки з'єднання), повторюються; повторювані невдачі можуть автоматично
вимкнути вебхук.
app.post("/webhook/tracio", async (req, res) => { res.status(200).send("OK") processWebhookEvent(req.body).catch(console.error)})
async function processWebhookEvent(event: WebhookPayload) { await db.events.insert(event)
if (event.decision.riskScore > 50) { await alertFraudTeam(event) }
if (event.bot.result === "bot") { await blockVisitor(event.visitorId) }}Скористайтеся дією Test на вебхуку (або POST .../webhooks/:webhookId/test),
щоб надіслати підписаний зразок корисного навантаження на ваш ендпоінт і
підтвердити, що він доступний і коректно перевіряє підписи.
Для локальної розробки відкрийте доступ до вашого сервера через тунель, як-от
ngrok:
ngrok http 3000# Use the generated URL as your webhook endpoint