Webhooki dostarczają zdarzenia identyfikacji na Twój serwer w czasie rzeczywistym.
Za każdym razem, gdy odwiedzający zostaje zidentyfikowany, TRACIO wysyła żądanie
HTTP POST na skonfigurowany adres URL webhooka. Treść żądania jest ładunkiem
zdarzenia — nie ma żadnej opakowującej koperty.
Treść to płaski dokument JSON w formacie camelCase. Jest to wyselekcjonowany
publiczny podzbiór wewnętrznego zdarzenia — bez hashy odcisku palca ani
wewnętrznych znaczników wykrywania.
{ "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 }}| Pole | Typ | Opis |
|---|---|---|
requestId | string | Unikalny identyfikator zdarzenia (jednocześnie klucz idempotentności) |
phase | string | primary lub late — patrz niżej |
visitorId | string | Stabilny identyfikator odwiedzającego |
linkedId | string | Powiązany identyfikator dostarczony przez klienta |
tag | string | Niestandardowy tag dostarczony przez klienta |
timestamp | string | Czas zdarzenia (RFC 3339) |
url | string | Adres URL strony, na której przechwycono zdarzenie |
ip | string | Adres IP klienta |
userAgent | string | Surowy ciąg user-agent klienta |
browser.name / .version | string | Wykryta przeglądarka |
os.name / .version | string | Wykryty system operacyjny |
device | string | Klasa urządzenia (np. desktop, mobile) |
geo | object | Geolokalizacja IP: country, city, lat, lon, timezone, isp |
network | object | vpn, proxy, tor, datacenter (wartości logiczne) oraz connectionType |
bot.result | string | human, bot lub uncertain |
bot.type | string | Dowolna etykieta automatyzacji, gdy wykryto bota |
bot.score | number | Wynik prawdopodobieństwa bota |
identification.confidence | number | Pewność modelu (0.0–1.0) |
identification.incognito | boolean | Prywatny kontekst przeglądania (incognito) |
identification.visitType | string | Klasyfikacja wizyty |
decision.action | string | Zalecane działanie |
decision.riskScore | number | Zagregowany wynik ryzyka (0–100) |
decision.suspectScore | number | Szczegółowy wynik podejrzliwości |
phase rozróżnia dwie dostawy, które współdzielą ten sam requestId:
primary — wysyłane natychmiast po zidentyfikowaniu odwiedzającego.late — kolejne zdarzenie wzbogacające (dopracowany werdykt dotyczący bota
oraz sygnały behawioralne przechwycone nieco później).Skoreluj obie dostawy po requestId i rozróżnij je po phase.
Każda dostawa zawiera nagłówek X-Tracio-Signature:
X-Tracio-Signature: t=1710432000,v1=5257a869e7ecebed...t to znacznik czasu Unix (w sekundach) z momentu podpisania żądania.v1 to zakodowany szesnastkowo HMAC-SHA256 z "<t>.<rawRequestBody>", z kluczem
będącym Twoim sekretem webhooka.Znacznik czasu jest częścią podpisanej treści, co zapewnia ochronę przed powtórzeniem
(replay) — weryfikuj względem surowego Buffer treści żądania (nie używaj
sparsowanego / ponownie zserializowanego JSON, w przeciwnym razie podpis się nie
zgodzi). Zbuduj podpisaną treść jako bajty: prefiks "<t>." połączony z surowym
buforem treści, a następnie wykonaj na tym 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")})Możesz też chcieć odrzucać dostawy, których t jest zbyt odległe od bieżącego
czasu (na przykład o więcej niż pięć minut różnicy), jako dodatkowe zabezpieczenie
przed powtórzeniem.
| Nagłówek | Opis |
|---|---|
Content-Type | application/json |
X-Tracio-Signature | t=<unix>,v1=<hmac_sha256_hex> nad "<t>.<rawBody>" |
X-Tracio-Event-Id | requestId zdarzenia — użyj go jako klucza idempotentności |
X-Tracio-Webhook-Id | Identyfikator webhooka, który wygenerował tę dostawę |
Najprostszym sposobem zarządzania webhookami jest wizualne zarządzanie w panelu
(dashboard). Można nimi również zarządzać programowo za pomocą API zarządzania
o zasięgu obszaru roboczego (workspace) — tego samego API, którego używa panel.
Jest ono serwowane na hoście aplikacji (na przykład https://app.tracio.ai/api/v1)
i uwierzytelniane za pomocą tokena JWT Twojej sesji panelu (Clerk); każde żądanie
jest dodatkowo sprawdzane względem Twojej roli w obszarze roboczym (RBAC). Nie ma
osobnego sekretu API. Wszystkie endpointy webhooków znajdują się pod
/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": [] }'Sekret podpisujący jest generowany przez TRACIO i zwracany jednorazowo przy
utworzeniu (oraz przy rotacji) w polu signingSecret. Przechowuj go bezpiecznie —
jest to klucz, którego używasz do weryfikacji podpisów.
{ "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" }}Przy kolejnych odczytach signingSecret jest maskowany (null) — jest ujawniany
wyłącznie przy utworzeniu i rotacji sekretu.
| Metoda | Ścieżka | Opis |
|---|---|---|
GET | /workspaces/{workspaceId}/webhooks | Lista webhooków |
PATCH | /workspaces/{workspaceId}/webhooks/{webhookId} | Aktualizacja url / events / status |
DELETE | /workspaces/{workspaceId}/webhooks/{webhookId} | Usunięcie webhooka |
POST | /workspaces/{workspaceId}/webhooks/{webhookId}/test | Wyślij podpisaną dostawę testową |
POST | /workspaces/{workspaceId}/webhooks/{webhookId}/secret/rotate | Rotacja sekretu podpisującego |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | Lista ostatnich prób dostawy |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | Lista ostatnich prób dostawy |
Dostawy mogą być ponawiane, więc Twój handler powinien być idempotentny.
Deduplikuj według nagłówka 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")})Zwracaj odpowiedź 2xx tak szybko, jak to możliwe, i przetwarzaj ładunek
asynchronicznie, aby uniknąć przekroczeń limitu czasu. Odpowiedzi inne niż 2xx
(oraz błędy połączenia) są ponawiane; powtarzające się niepowodzenia mogą
automatycznie wyłączyć webhook.
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) }}Użyj akcji Test przy webhooku (lub POST .../webhooks/:webhookId/test), aby
wysłać podpisany przykładowy ładunek do swojego endpointu i potwierdzić, że jest
osiągalny oraz poprawnie weryfikuje podpisy.
W przypadku lokalnego środowiska programistycznego udostępnij swój serwer przez
tunel taki jak ngrok:
ngrok http 3000# Use the generated URL as your webhook endpoint