Webhooky doručují identifikační události na váš server v reálném čase. Pokaždé,
když je návštěvník identifikován, TRACIO odešle HTTP požadavek POST na vaši
nakonfigurovanou URL webhooku. Tělo požadavku je payload události — neexistuje
žádná obalová obálka.
Tělo je plochý JSON dokument v camelCase. Jde o kurátorovanou veřejnou podmnožinu
interní události — bez fingerprint hashů a interních detekčních markerů.
{ "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 | Popis |
|---|---|---|
requestId | string | Jedinečný identifikátor události (zároveň klíč idempotence) |
phase | string | primary nebo late — viz níže |
visitorId | string | Stabilní identifikátor návštěvníka |
linkedId | string | Propojený identifikátor dodaný klientem |
tag | string | Vlastní tag dodaný klientem |
timestamp | string | Čas události (RFC 3339) |
url | string | URL stránky, kde byla událost zachycena |
ip | string | IP adresa klienta |
userAgent | string | Surový řetězec user-agent klienta |
browser.name / .version | string | Zjištěný prohlížeč |
os.name / .version | string | Zjištěný operační systém |
device | string | Třída zařízení (např. desktop, mobile) |
geo | object | IP geolokace: country, city, lat, lon, timezone, isp |
network | object | vpn, proxy, tor, datacenter (booleany) a connectionType |
bot.result | string | human, bot nebo uncertain |
bot.type | string | Volný popisek automatizace, když je detekován bot |
bot.score | number | Skóre pravděpodobnosti bota |
identification.confidence | number | Konfidence modelu (0.0–1.0) |
identification.incognito | boolean | Kontext soukromého/anonymního prohlížení |
identification.visitType | string | Klasifikace návštěvy |
decision.action | string | Doporučená akce |
decision.riskScore | number | Souhrnné skóre rizika (0–100) |
decision.suspectScore | number | Jemně odstupňované skóre podezření |
phase rozlišuje dvě doručení, která sdílejí stejné requestId:
primary — odesláno okamžitě po identifikaci návštěvníka.late — následná obohacovací událost (upřesněný verdikt o botovi a
behaviorální signály zachycené o něco později).Obě propojte pomocí requestId a rozlišujte je podle phase.
Každé doručení obsahuje hlavičku X-Tracio-Signature:
X-Tracio-Signature: t=1710432000,v1=5257a869e7ecebed...t je unixové časové razítko (v sekundách), kdy byl požadavek podepsán.v1 je hexadecimálně kódovaný HMAC-SHA256 z "<t>.<rawRequestBody>", klíčovaný
vaším tajným klíčem webhooku.Časové razítko je součástí podepsaného obsahu, což poskytuje ochranu proti replay
útokům — ověřujte proti surovému Bufferu těla požadavku (nepoužívejte
naparsovaný/znovu serializovaný JSON, jinak se podpis nebude shodovat). Sestavte
podepsaný obsah jako bajty: prefix "<t>." zřetězený se surovým bufferem těla,
poté nad ním vytvořte 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")})Můžete také odmítat doručení, jejichž t je příliš vzdálené od aktuálního času
(například více než pět minut odchylky), jako další ochranu proti replay útokům.
| Hlavička | Popis |
|---|---|
Content-Type | application/json |
X-Tracio-Signature | t=<unix>,v1=<hmac_sha256_hex> nad "<t>.<rawBody>" |
X-Tracio-Event-Id | requestId události — použijte jej jako klíč idempotence |
X-Tracio-Webhook-Id | Identifikátor webhooku, který toto doručení vytvořil |
Nejjednodušší způsob správy webhooků je vizuálně v dashboardu. Lze je také
spravovat programaticky prostřednictvím management API v rámci workspace — téhož
API, které používá dashboard. Je poskytováno na hostiteli aplikace (například
https://app.tracio.ai/api/v1) a autentizováno vaším JWT relace dashboardu
(Clerk); každý požadavek je navíc kontrolován proti vaší roli ve workspace
(RBAC). Neexistuje žádný samostatný tajný klíč API. Všechny endpointy webhooků se
nacházejí 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": [] }'Podepisovací tajný klíč je generován službou TRACIO a vrácen jednou při
vytvoření (a při rotaci) pod signingSecret. Uložte jej bezpečně — je to klíč,
kterým ověřujete podpisy.
{ "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" }}Při následných čteních je signingSecret maskován (null) — odhalen je pouze při
vytvoření a rotaci tajného klíče.
| Metoda | Cesta | Popis |
|---|---|---|
GET | /workspaces/{workspaceId}/webhooks | Výpis webhooků |
PATCH | /workspaces/{workspaceId}/webhooks/{webhookId} | Aktualizace url / events / status |
DELETE | /workspaces/{workspaceId}/webhooks/{webhookId} | Smazání webhooku |
POST | /workspaces/{workspaceId}/webhooks/{webhookId}/test | Odeslání podepsaného testovacího doručení |
POST | /workspaces/{workspaceId}/webhooks/{webhookId}/secret/rotate | Rotace podepisovacího tajného klíče |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | Výpis nedávných pokusů o doručení |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | Výpis nedávných pokusů o doručení |
Doručení mohou být opakována, takže váš handler by měl být idempotentní.
Deduplikujte podle hlavičky X-Tracio-Event-Id (dle 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")})Vraťte odpověď 2xx co nejrychleji a payload zpracovávejte asynchronně, abyste
předešli timeoutům. Odpovědi jiné než 2xx (a chyby spojení) jsou opakovány;
opakovaná selhání mohou webhook automaticky deaktivovat.
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) }}Použijte akci Test na webhooku (nebo POST .../webhooks/:webhookId/test)
k odeslání podepsaného ukázkového payloadu na váš endpoint a k ověření, že je
dosažitelný a správně ověřuje podpisy.
Pro lokální vývoj zpřístupněte svůj server pomocí tunelu, jako je ngrok:
ngrok http 3000# Use the generated URL as your webhook endpoint