Webhooks доставляют события идентификации на ваш сервер в реальном времени. Каждый
раз, когда посетитель идентифицирован, TRACIO отправляет HTTP-запрос POST на
настроенный вами URL webhook. Тело запроса и есть payload события — никакого
обёртывающего конверта нет.
Тело — это плоский 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 }}| Поле | Тип | Описание |
|---|---|---|
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 от "<t>.<rawRequestBody>" в hex-кодировке, с ключом —
вашим секретом webhook.Таймстамп является частью подписываемого содержимого, что даёт защиту от повторов
(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 слишком далеко от текущего
времени (например, отклонение более пяти минут), в качестве дополнительной защиты от
повторов.
| Заголовок | Описание |
|---|---|
Content-Type | application/json |
X-Tracio-Signature | t=<unix>,v1=<hmac_sha256_hex> от "<t>.<rawBody>" |
X-Tracio-Event-Id | requestId события — используйте как ключ идемпотентности |
X-Tracio-Webhook-Id | Идентификатор webhook, который сформировал эту доставку |
Проще всего управлять webhooks визуально в дашборде. Ими также можно управлять
программно через management API с областью действия workspace — тот же API, что
использует дашборд. Он обслуживается на хосте приложения (например,
https://app.tracio.ai/api/v1) и аутентифицируется вашим JWT сессии дашборда
(Clerk); каждый запрос дополнительно проверяется по вашей роли в workspace (RBAC).
Отдельного секрета API нет. Все эндпоинты webhook находятся под
/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) — он раскрывается
только при создании и при ротации секрета.
| Метод | Путь | Описание |
|---|---|---|
GET | /workspaces/{workspaceId}/webhooks | Список webhooks |
PATCH | /workspaces/{workspaceId}/webhooks/{webhookId} | Обновить url / events / status |
DELETE | /workspaces/{workspaceId}/webhooks/{webhookId} | Удалить webhook |
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 как можно быстрее и обрабатывайте payload асинхронно, чтобы
избежать таймаутов. Ответы, отличные от 2xx (и ошибки соединения), повторяются;
многократные сбои могут автоматически отключить 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) }}Используйте действие Test на webhook (или POST .../webhooks/:webhookId/test),
чтобы отправить подписанный образец payload на ваш эндпоинт и убедиться, что он
доступен и корректно проверяет подписи.
Для локальной разработки откройте доступ к вашему серверу через туннель, например
ngrok:
ngrok http 3000# Use the generated URL as your webhook endpoint