Webhook

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/webhook-endpoint.schema.json",
  "title": "Webhook",
  "description": "The address a group’s events are delivered to, signed.",
  "type": "object",
  "properties": {
    "groupId": {
      "type": "string",
      "description": "Protection resource group the webhook belongs to; at most one webhook per group."
    },
    "url": {
      "type": "string",
      "description": "Delivery address, masked (origin + last 4 characters). The plain address and the signing secret are never returned by a read."
    },
    "events": {
      "type": "array",
      "description": "Subscribed events: `leak.created`, `scan.finished`, `scan.failed`.",
      "items": {}
    },
    "severities": {
      "type": "array",
      "description": "Severity filter for leak events; leaks with a severity not in the list are not sent.",
      "items": {}
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether delivery is on."
    },
    "lastDelivery": {
      "type": "object",
      "description": "Summary of the last delivery; `null` if nothing was delivered yet.",
      "properties": {
        "at": {
          "type": "string",
          "description": "Time of the last delivery."
        },
        "ok": {
          "type": "boolean",
          "description": "Whether the receiver returned `2xx`."
        },
        "type": {
          "type": "string",
          "description": "Type of the last delivered event."
        },
        "reason": {
          "type": [
            "string",
            "null"
          ],
          "description": "Reason if it failed (e.g. `http_503`, `timeout`); `null` on success."
        }
      }
    },
    "createdAt": {
      "type": "string",
      "description": "Creation time (ISO 8601)."
    },
    "updatedAt": {
      "type": "string",
      "description": "Last update time (ISO 8601)."
    }
  }
}