Webhooki formaat

SilentShield saab saata reaalajas teavitusi teie serverile webhookide kaudu. Seadistage webhooki URL-id jaotises Töölaud → Teavitused.

Andmepaketi struktuur

Kõik webhooki andmepaketid järgivad seda struktuuri:

{"event": "bot_detected", "timestamp": "2025-01-15T10:30:00Z", "data": {"keyId": "key_abc", "domain": "example.com", "ip": "203.0.113.42", "verdict": "bot", "score": 0.15, "userAgent": "Mozilla/5.0...", "page": "/contact"}}

Sündmuste tüübid

Event	Description
`bot_detected`	Käivitatakse, kui päring klassifitseeritakse botina.
`bot_spike`	Käivitatakse, kui botide tuvastamine ületab teie teavitusläve seadistatud ajaaknas.
`quota_warning`	Käivitatakse, kui kvoodi kasutus jõuab 80% või 90% tasemele.
`quota_exceeded`	Käivitatakse, kui teie igakuine kvoot on ületatud.
`domain_verification_failed`	Käivitatakse, kui domeeni taaskinnitus ebaõnnestub.
`key_rotated`	Käivitatakse, kui API-võti vahetatakse.

Allkirja kontrollimine

Iga webhook sisaldab X-SilentShield-Signature päist HMAC-SHA256 allkirjaga. Kontrollige seda allkirja, et veenduda webhooki autentsuses.

Saage päringu toorkeha (stringina, enne parsimist)
Saage X-SilentShield-Signature päise väärtus
Arvutage keha HMAC-SHA256, kasutades võtmena oma webhooki saladust
Võrrelge arvutatud allkirja päise väärtusega

const crypto = require('crypto');

function verifyWebhook(body, signature, secret) {
  const computed = crypto
    .createHmac('sha256', secret)
    .update(body)
    .digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(computed),
    Buffer.from(signature)
  );
}

Uuesti proovimise poliitika

Kui teie lõpp-punkt tagastab mitte-2xx staatuskoodi või aegub (10 sekundit), proovib SilentShield edastust uuesti kuni 3 korda eksponentsiaalse viivitusega (1 minut, 5 minutit, 30 minutit). Pärast 3 ebaõnnestunud katset märgitakse webhook ebaõnnestunuks ja see on nähtav jaotises Töölaud → Teavitused → Ebaõnnestunud edastused.

Webhooki saladus

Teie webhooki saladus genereeritakse, kui loote webhooki lõpp-punkti töölaua kaudu. Saate seda vaadata või uuesti genereerida jaotises Töölaud → Teavitused → Webhookid → Muuda.