WebhookSubscriptions

Rotate webhook subscription secret

Rotates a webhook subscription's secret. The previous secret for a subscription is no longer valid after a new one is generated. Requires an OAuth access token; API keys are not supported.

post/1.0/webhook_subscriptions/{subscriptionId}/actions/rotateSecret

Request

Base URL
https://api.squarespace.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/squarespace/apis/commerce-api/docs/1.0/webhook_subscriptions/:subscriptionId/actions/rotateSecret/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

subscriptionIdstring required

Specifies the Webhook Subscription to update.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Response

secretstring

Hexadecimal value used to generate a signature for a webhook notification; field is only returned when creating a new subscription or rotating a secret. Store the secret in a safe location to verify notifications from Squarespace.

Changes

No recorded changes to this operation across all 1 revision of this API.