Skip to main content

​
Method

POST /v1/webhooks/subscriptions/:id/rotate-secret

​
Path Parameters

​
id
uuid
required
Webhook subscription ID.

​
Headers

​
Authorization
string
Bearer token (requires webhooks:write).

​
Request Example

curl -X POST "https://api.voyantcloud.com/v1/webhooks/subscriptions/whsub_01J0J3Y3TFX2V22Y7DQ0A6J5G5/rotate-secret" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

​
Response Example

{
  "data": {
    "secret": "52a2e84247a064d7a2d91b0f4d12d8a22a9fc68bfb9984f0b1d03cc9093f02eb",
    "subscription": {
      "id": "whsub_01J0J3Y3TFX2V22Y7DQ0A6J5G5",
      "workspace_id": "ws_4a82d5bd-3330-4ad3-bf46-1b6a9a5d5d6a",
      "url": "https://example.com/webhooks/voyant",
      "events": ["product.*", "booking.created"],
      "active": true,
      "max_retries": 5,
      "headers": {"X-Env": "production"},
      "description": "Primary catalog listener",
      "created_at": "2025-03-01T09:12:33.000Z",
      "updated_at": "2025-03-15T12:05:22.000Z",
      "last_delivery_at": "2025-03-15T11:59:10.000Z",
      "failure_count": 0
    }
  }
}
Rotating the secret invalidates the old key immediately. Update your webhook consumer before triggering new events to avoid signature mismatches.