Template Docs Commerce APIs Webhooks Custom Code Upcoming Changes
Get Started
Template Docs Commerce APIs Webhooks Custom Code Upcoming Changes
Get Started
Getting started
Overview Authentication and permissions Making requests Retrieve basic site information
Using Commerce APIs
Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ
Inventory API
Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities
Orders API
Overview POST: Create an order POST: Fulfill an order GET: Retrieve all orders GET: Retrieve a specific order
Products API
Overview About product attributes Managing attributes POST: Create a product POST: Create a product variant POST: Upload a product image GET: Retrieve all Store Pages GET: Retrieve all products GET: Retrieve specific products GET: Product image upload status POST: Assign a product image to variant POST: Reorder a product image POST: Update a product POST: Update a product variant POST: Update a product image DEL: Delete a product DEL: Delete a product variant DEL: Delete a product image
Profiles API
Overview GET: Retrieve all profiles GET: Retrieve specific profiles
Transactions API
Overview GET: Retrieve all transactions GET: Retrieve specific transactions
Webhook Subscriptions API
Overview POST: Create a webhook subscription POST: Update a webhook subscription GET: Retrieve all webhook subscriptions GET: Retrieve a specific webhook subscription DEL: Delete a webhook subscription POST: Send test notification POST: Rotate a subscription secret

Send test notification

POST /api.squarespace.com/{api-version}/webhook_subscriptions/{id}/actions/sendTestNotification

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.

The response contains the status code returned by the subscribed webhook endpoint.

Parameters

{api-version} string
required

See the Webhook Subscriptions API Overview page for the current API version.

{id} string
required

Specifies the Webhook Subscription to send a notification to.

Request example

Read the Overview to learn about specific API permissions. Every request should also abide by Squarespace rate limits.

curl "https://api.squarespace.com/1.0/webhook_subscriptions/123/actions/sendTestNotification" \ -i \ -H "Authorization: Bearer YOUR_OAUTH_TOKEN" \ -H "User-Agent: YOUR_CUSTOM_APP_DESCRIPTION" \ -H "Content-Type: application/json" \ -X POST \ -d '{' \ # Required; string. # Squarespace event topic that triggers a webhook notification. # Possible values include: `extension.uninstall`, `order.create`, `order.update`. '"topic": "extension.uninstall",' \ '}'

Response example

A successful request generates a JSON response with the status code returned from the webhook endpoint.

Note: For easier reference between response fields and descriptions, comments were added in the example, though this makes the JSON invalid.

{ // Status code returned by the subscribed webhook endpoint. "statusCode": 200 }

Status codes and error conditions

200 OK

The request was successful. The message body contains data in the format specified above.

400 BAD REQUEST

Type: INVALID_REQUEST_ERROR

Subtype: null
The request body does not conform to the required specification.

404 NOT FOUND

Type: INVALID_REQUEST_ERROR

Subtype: INVALID_ARGUMENT The requested Webhook Subscription was not found.