List webhooks

The firm’s webhooks, at most one per protection resource group. The address is masked; the signing secret is never returned by a read. A restricted key sees only its allowed groups’ webhooks.

GET/v1/webhooks

GETList webhooks

curl -X GET "https://api.darkradar.com/api/public/v1/webhooks" \
  -H "x-api-key: $DARKRADAR_API_KEY"

Response

Success

{
  "success": true,
  "message": "OK",
  "data": {
    "webhooks": [
      {
        "groupId": "64b1f0c2a9e4d21f8c3b9a10",
        "url": "•••• https://darkradar.com/…hook",
        "events": [
          "leak.created",
          "scan.finished",
          "scan.failed"
        ],
        "severities": [
          "critical",
          "high"
        ],
        "isActive": true,
        "lastDelivery": {
          "at": "2026-09-19T15:33:20.772Z",
          "ok": true,
          "type": "scan.finished",
          "reason": null
        },
        "createdAt": "2026-09-19T15:33:20.631Z",
        "updatedAt": "2026-09-19T15:33:20.673Z"
      }
    ]
  }
}

Access

Scopewebhooks:read

Plan entitlementapi_access

Responses

200Success

400Invalid request (malformed id, missing or invalid field)

401Key missing, invalid, expired or revoked

403Insufficient scope, no API access in plan, or product not enabled

404Record not found or not owned by this key’s firm

408The request exceeded its maximum response time

429Rate limit exceeded; retry after a minute

WebhookResponse model

Response limits

Rate limit500 requests per 15 min · per IP

{ "success": true, "message": "OK", "data": { "webhooks": [ { "groupId": "64b1f0c2a9e4d21f8c3b9a10", "url": "•••• https://darkradar.com/…hook", "events": [ "leak.created", "scan.finished", "scan.failed" ], "severities": [ "critical", "high" ], "isActive": true, "lastDelivery": { "at": "2026-09-19T15:33:20.772Z", "ok": true, "type": "scan.finished", "reason": null }, "createdAt": "2026-09-19T15:33:20.631Z", "updatedAt": "2026-09-19T15:33:20.673Z" } ] } }