WebhookSubscriptions

Send test notification

Sends a notification to a subscribed webhook endpoint for testing purposes. This is a one-time notification, and will not be retried if it fails or times out. Requires an OAuth access token; API keys are not supported.

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

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/sendTestNotification/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

subscriptionIdstring required

Specifies the Webhook Subscription to send a notification to.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Request body

topicstring required

Required; Squarespace event topic that triggers a webhook notification. Possible values include: extension.uninstall, order.create, order.update.

Response

statusCodeinteger

Status code returned by the subscribed webhook endpoint.

Changes

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