Rotate a webhook channel's signing secret

POST

/channels/:id/rotate-secret

Sets (first time) or rotates the Standard Webhooks secret a webhook channel verifies inbound deliveries against. The outgoing secret keeps verifying for one rotation cycle. The secret is never returned in any response — only an opaque Vault reference. Authorization: organization administrators only. Returns 400 if the channel is not a webhook channel, 404 if not found.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

secretstringRequired

whsec_-prefixed base64.

Response

The channel, with its secret rotated.

channelobject

$	curl -X POST https://api.cloudraker.com/channels/id/rotate-secret \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"secret": "whsec_dGhpc2lzYXNlY3JldGtleQ=="
>	}'

1	{
2	"channel": {
3	"_id": "ch_9f8b7c6d5e4a3b2c1d0e",
4	"slug": "order-webhook",
5	"name": "Order Webhook Channel",
6	"type": "webhook",
7	"address": "https://hooks.example.com/order",
8	"webhookSecretVaultId": "vault_123abc456def",
9	"status": "active",
10	"createdAt": "2024-05-20T10:15:30Z",
11	"archivedAt": "null",
12	"createdBy": "user_42a1b2c3d4e5f6",
13	"folderId": "folder_789xyz"
14	}
15	}