SafeWeb API
Partner API

List webhook endpoints

GET
/api/v1/integrations/webhooks

Header Parameters

SW-PARTNER-ID*string

Partner organization identifier

SW-API-KEY*string

API authentication key

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/integrations/webhooks" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string"
{
  "success": true,
  "webhooks": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "url": "http://example.com",
      "eventTypes": [
        "string"
      ],
      "enabled": true,
      "maxAttempts": 1,
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}

Webhooks overview

Partner-facing HTTP APIs to register outbound webhook URLs and manage signing secrets. For the delivery protocol, event catalogue, and receiver implementation details, read the top-level Outbound webhooks guide.

Create a webhook endpoint POST

Registers a new HTTPS webhook URL for the authenticated partner organization. Provide `url`, at least one `eventTypes` value (canonical names such as customer.breach.found), and optionally `enabled` and `maxAttempts` (1–3). Signing secrets are managed separately via the webhook secrets endpoints.