Webhooks מספקים אירועי זיהוי לשרת שלכם בזמן אמת. בכל פעם שמבקר מזוהה, TRACIO
שולחת בקשת HTTP POST לכתובת ה-webhook שהגדרתם. גוף הבקשה הוא מטען
(payload) האירוע — אין מעטפה עוטפת.
הגוף הוא מסמך JSON שטוח בפורמט camelCase. זהו תת-קבוצה ציבורית ומאוצרת של
האירוע הפנימי — ללא hashes של טביעת אצבע וללא סמני זיהוי פנימיים.
{ "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 | מזהה אירוע ייחודי (גם מפתח idempotency) |
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 | הקשר גלישה פרטית/incognito |
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>", עם ה-webhook
secret שלכם כמפתח.חותמת הזמן היא חלק מהתוכן החתום, מה שמספק הגנה מפני 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 שלהן רחוק מדי מהזמן הנוכחי (למשל, יותר מחמש
דקות של סטייה) כשכבת הגנה נוספת מפני replay.
| כותרת | תיאור |
|---|---|
Content-Type | application/json |
X-Tracio-Signature | t=<unix>,v1=<hmac_sha256_hex> על "<t>.<rawBody>" |
X-Tracio-Event-Id | ה-requestId של האירוע — השתמשו בו כמפתח idempotency |
X-Tracio-Webhook-Id | מזהה ה-webhook שהפיק את המסירה הזו |
הדרך הפשוטה ביותר לנהל webhooks היא באופן חזותי ב-dashboard. ניתן לנהל אותם
גם באופן תוכנתי דרך ה-management API בהיקף ה-workspace — אותו API שבו משתמש
ה-dashboard. הוא מוגש על מארח האפליקציה (למשל https://app.tracio.ai/api/v1)
ומאומת באמצעות ה-JWT של session ה-dashboard שלכם (Clerk); כל בקשה נבדקת
בנוסף מול תפקיד ה-workspace שלכם (RBAC). אין API secret עצמאי. כל נקודות הקצה של
ה-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": [] }'ה-signing secret מיוצר על ידי 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) — הוא נחשף רק ביצירה ובעת
סבבת ה-secret.
| שיטה | נתיב | תיאור |
|---|---|---|
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 | סבבת ה-signing secret |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | רשימת ניסיונות מסירה אחרונים |
GET | /workspaces/{workspaceId}/webhooks/{webhookId}/deliveries | רשימת ניסיונות מסירה אחרונים |
מסירות עשויות להישלח שוב, לכן ה-handler שלכם צריך להיות idempotent. בצעו
deduplication לפי הכותרת 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 מהר ככל האפשר ועבדו את המטען באופן אסינכרוני כדי להימנע
מ-timeouts. תגובות שאינן 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)
כדי לשלוח מטען לדוגמה חתום לנקודת הקצה שלכם ולוודא שהיא נגישה ומאמתת חתימות
כראוי.
לפיתוח מקומי, חשפו את השרת שלכם באמצעות tunnel כגון ngrok:
ngrok http 3000# Use the generated URL as your webhook endpoint