Squarespace

Squarespace Webhook Subscriptions API

The Squarespace Webhook Subscriptions API allows developers to manage webhook endpoint subscriptions for a merchant site. It supports creating, listing, updating, and deleting subscriptions that trigger notifications for order events, extension uninstalls, and other commerce activities.

GitHub OpenAPI

Operations 14

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /webhook_subscriptions List webhook subscriptions · Retrieve All Webhook Subscriptions #
Ask an LLM
“Which webhook endpoints are currently subscribed on my site?”
“How close am I to the 25 active webhook subscription limit?”
Tell an agent
List all webhook subscriptions configured for my site.
Show every webhook subscription with its endpoint URL and topics.
POST /webhook_subscriptions Subscribe an endpoint to webhook events · Create a Webhook Subscription #
Ask an LLM
“How do I get notified at my own URL when store events happen on Squarespace?”
“Do I get a secret for verifying signatures when I create a webhook subscription?”
Tell an agent
Create a webhook subscription sending {topics} events to {endpointUrl}.
Subscribe {endpointUrl} to webhook topics {topics}.
GET /webhook_subscriptions/{subscriptionId} Get one webhook subscription · Retrieve a Specific Webhook Subscription #
Ask an LLM
“What endpoint URL and topics does a specific webhook subscription use?”
“Can I see a single webhook subscription's configuration by its ID?”
Tell an agent
Get webhook subscription {subscriptionId}.
Show the endpoint and topics for webhook subscription {subscriptionId}.
POST /webhook_subscriptions/{subscriptionId} Change a webhook's endpoint or topics · Update a Webhook Subscription #
Ask an LLM
“How do I point an existing webhook subscription at a new URL?”
“Can I add or remove event topics on a webhook I already set up?”
Tell an agent
Change the endpoint of webhook subscription {subscriptionId} to {endpointUrl}.
Set the topics of webhook subscription {subscriptionId} to {topics}.
DELETE /webhook_subscriptions/{subscriptionId} Delete a webhook subscription · Delete a Webhook Subscription #
Ask an LLM
“How do I stop receiving webhook notifications at an endpoint?”
“Can I permanently remove a webhook subscription by ID?”
Tell an agent destructive · confirm first
Delete webhook subscription {subscriptionId}.
Unsubscribe and remove webhook {subscriptionId}.
POST /webhook_subscriptions/{subscriptionId}/actions/sendTestNotification Send a test webhook notification · Send a Test Notification #
Ask an LLM
“How can I check that my webhook endpoint is reachable before live events arrive?”
“Can I trigger a sample webhook payload to test my handler?”
Tell an agent
Send a test notification to webhook subscription {subscriptionId}.
Fire a test event at the endpoint of webhook {subscriptionId}.
POST /webhook_subscriptions/{subscriptionId}/actions/rotateSecret Rotate a webhook subscription's secret · Rotate a Webhook Subscription Secret #
Ask an LLM
“How do I generate a new signing secret if my webhook secret may have leaked?”
“Does rotating a webhook secret invalidate the old one immediately?”
Tell an agent destructive · confirm first
Rotate the secret for webhook subscription {subscriptionId}.
Issue a new signing secret for webhook {subscriptionId} and invalidate the old one.
GET /1.0/webhook_subscriptions List webhook subscriptions (1.0) · List webhook subscriptions #
Ask an LLM
“Which webhook subscriptions exist on my site through the 1.0 API?”
“Why does listing webhook subscriptions fail with an API key instead of OAuth?”
Tell an agent
List my 1.0 webhook subscriptions.
Fetch all webhook subscriptions with user agent {user_agent}.
POST /1.0/webhook_subscriptions Create a webhook subscription (1.0) · Create webhook subscription #
Ask an LLM
“How do I register an HTTPS URL to receive order.create events?”
“What OAuth scopes does my token need for each webhook topic I subscribe to?”
Tell an agent
Create a webhook subscription posting to {endpointUrl}.
Subscribe {endpointUrl} to the event topics {topics}.
DELETE /1.0/webhook_subscriptions/{subscriptionId} Delete a webhook subscription (1.0) · Delete webhook subscription #
Ask an LLM
“How do I delete a webhook subscription I no longer use?”
“Can I remove a webhook subscription with an API key, or only OAuth?”
Tell an agent destructive · confirm first
Delete 1.0 webhook subscription {subscriptionId} using my OAuth token.
Remove the webhook {subscriptionId} so it stops receiving events.
GET /1.0/webhook_subscriptions/{subscriptionId} Get a webhook subscription (1.0) · Get webhook subscription #
Ask an LLM
“How do I view the details of one webhook subscription?”
“Which topics is a particular webhook subscription listening for?”
Tell an agent
Fetch 1.0 webhook subscription {subscriptionId} using my OAuth token.
Show the configuration of webhook {subscriptionId}.
POST /1.0/webhook_subscriptions/{subscriptionId} Update a webhook subscription (1.0) · Update webhook subscription #
Ask an LLM
“Can I change the URL an existing webhook subscription posts to?”
“How do I update which events an existing webhook is subscribed to?”
Tell an agent
Update webhook subscription {subscriptionId} to post to {endpointUrl}.
Replace the topics on webhook {subscriptionId} with {topics}.
POST /1.0/webhook_subscriptions/{subscriptionId}/actions/rotateSecret Rotate a webhook subscription secret (1.0) · Rotate webhook subscription secret #
Ask an LLM
“How do I replace the signing secret on a webhook subscription?”
“Is the previous webhook secret still valid after I rotate it?”
Tell an agent destructive · confirm first
Rotate the secret on webhook subscription {subscriptionId}.
Generate a fresh secret for webhook {subscriptionId}.
POST /1.0/webhook_subscriptions/{subscriptionId}/actions/sendTestNotification Send a test notification for one topic (1.0) · Send test notification #
Ask an LLM
“How do I send a one-off test event for a specific topic to my webhook?”
“Will a failed test webhook notification be retried?”
Tell an agent
Fire a one-time {topic} test event at 1.0 webhook {subscriptionId}, with no retries.
Test webhook {subscriptionId} with a sample {topic} event.

Documentation

📖
Documentation
https://developers.squarespace.com/webhooks/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/openapi/squarespace-webhook-subscriptions-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/asyncapi/squarespace-webhooks-asyncapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/overlays/squarespace-webhook-subscriptions-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/squarespace:squarespace-webhook-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

squarespace-webhook-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Squarespace Commerce Inventory Webhook Subscriptions API
  description: The Squarespace Commerce API provides programmatic access to the commerce features of a Squarespace merchant site. It enables developers to build integrations and applications that manage products, process orders, track inventory, access customer profiles, retrieve financial transactions, and configure webhook subscriptions. All endpoints use HTTPS and follow REST principles with standard verbs and response status codes. Authentication is handled via API keys or OAuth tokens.
  version: '1.0'
  contact:
    name: Squarespace Developer Support
    url: https://developers.squarespace.com/commerce-apis/overview
  termsOfService: https://www.squarespace.com/terms-of-service
servers:
- url: https://api.squarespace.com/1.0
  description: Production Server
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/squarespace/refs/heads/main/openapi/squarespace-webhook-subscriptions-api-openapi.yml