Webhooks

Configure webhooks to receive security events (alerts, scan results, incident notifications) in real time.

Setting up a webhook

1. Provide a publicly reachable HTTPS URL.
2. We will send POST requests with a JSON body and a signature header for verification.

Payload example

{
  "id": "evt_xxx",
  "type": "alert.new",
  "created_at": "2024-01-15T12:00:00Z",
  "data": {
    "severity": "high",
    "message": "Unusual withdrawal pattern detected"
  }
}

Verifying signatures

Check the X-BSBsec-Signature header to ensure the request came from BSBsec. (Verification details will be documented when the API is live.)

Adding more docs

Add new .md files in content/docs/. Use the same frontmatter: title, description. The sidebar is built automatically from these files.