SafeWeb API
Distributor API

Generate distributor webhook signing secret

POST
/api/v1/distributors/webhooks/secrets

Header Parameters

SW-DISTRIBUTOR-ID*string
SW-API-KEY*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/distributors/webhooks/secrets" \  -H "SW-DISTRIBUTOR-ID: string" \  -H "SW-API-KEY: string" \  -H "Content-Type: application/json" \  -d '{    "scope": "distributor"  }'
{
  "success": true,
  "secret": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "token": "string"
  }
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}

Delete distributor webhook endpoint DELETE

Permanently removes a distributor-scoped webhook endpoint for the authenticated distributor.

Cycle distributor webhook signing secret POST

Rotates distributor webhook signing secrets. Send a JSON body with `scope` set to `distributor` (see OpenAPI). A new active token is returned once.