Distributor API
Cycle distributor webhook signing secret
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
curl -X POST "https://example.com/api/v1/distributors/webhooks/secrets/cycle" \ -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"
}Generate distributor webhook signing secret POST
Creates a signing secret for the authenticated distributor’s webhook scope. Provide a JSON body with `scope` (for example `distributor`). The token is returned once; store it securely.
Deactivate distributor webhook signing secret DELETE
Deactivates a distributor webhook signing secret by id for the authenticated distributor.