Template Docs Commerce APIs Webhooks Tools
Get Started
Template Docs Commerce APIs Webhooks Tools
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

Webhook Subscriptions API overview

Current version: 1.0
For versioning details, read the Upgrade guide.

Subscribe to notifications from Squarespace websites by configuring a webhook endpoint with the Webhooks Subscriptions API. But before using this API, read the Webhooks overview for details on subscriptions and notifications.

Note: Requests to the Webhook Subscriptions API must authenticate using an OAuth token. See the Authentication and permissions guide for details. In addition, the token must have appropriate permissions for certain event types.

API resources

The Webhooks Subscriptions API returns information in Webhook Subscription resource objects. The resource includes information like the subscribed webhook endpoint and events the endpoint is subscribed to.

Resource fields are described under Response example for each Webhook Subscriptions API endpoint.

Further reading

  • Become familiar with common commerce terms and how they're related to the API
  • Read the FAQ guide for answers to common questions