SafeWeb API
Partner API

Get webhook endpoint

GET
/api/v1/integrations/webhooks/{webhookId}

Path Parameters

webhookId*string
Formatuuid

Header Parameters

SW-PARTNER-ID*string
SW-API-KEY*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/integrations/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string"
{
  "success": true,
  "webhook": {
    "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"
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}

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.

Update a webhook endpoint PATCH

Updates one or more fields on an existing webhook endpoint. Include at least one of `url`, `eventTypes`, `enabled`, or `maxAttempts`. The endpoint must belong to the authenticated partner organization.