How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Squarespace Webhook Subscriptions API

The WebhookSubscriptions API from Squarespace — 4 operation(s) for webhooksubscriptions.

Squarespace Webhook Subscriptions API is one of 13 APIs that Squarespace publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 7 operations across 4 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2.

Requests are made against a single base URL, https://api.squarespace.com.

7 operations 4 paths 32 schemas 1 DELETE2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2
Server
https://api.squarespace.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Squarespace Webhook Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Authorization). By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

WebhookSubscriptions 7
GET
/1.0/webhook_subscriptions
List webhook subscriptions
getWebhookSubscriptions 2 params → 200404
POST
/1.0/webhook_subscriptions
Create webhook subscription
createWebhookSubscription 2 params body → 201400404409
DELETE
/1.0/webhook_subscriptions/{subscriptionId}
Delete webhook subscription
deleteWebhookSubscription 3 params → 204404
GET
/1.0/webhook_subscriptions/{subscriptionId}
Get webhook subscription
getWebhookSubscription 3 params → 200404
POST
/1.0/webhook_subscriptions/{subscriptionId}
Update webhook subscription
updateWebhookSubscription 3 params body → 200400404
POST
/1.0/webhook_subscriptions/{subscriptionId}/actions/rotateSecret
Rotate webhook subscription secret
rotateSubscriptionSecret 3 params → 200404
POST
/1.0/webhook_subscriptions/{subscriptionId}/actions/sendTestNotification
Send test notification
sendTestNotificationForWebhookSubscription 3 params body → 200400404

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ContactAddress (9 properties), ExternalCreateWebhookSubscriptionResponse (8 properties), ExternalWebhookSubscriptionResponse (7 properties), Contact (7 properties). Each schema is shown below with its type and property counts.

ExternalWebhookSubscriptionListResponse
object
1 property
OrderUpdatePayload
object
6 properties 5 required
ContactCreatePayload
object
6 properties 5 required
ContactDeletePayload
object
6 properties 5 required
AddressUpdateData
object
The address data after the update.
4 properties 2 required
AddressCreatePayload
object
6 properties 5 required
ExternalWebhookSubscriptionResponse
object
7 properties
AddressDeleteData
object
Identifiers and metadata for the deleted address book entries.
3 properties 2 required
AddressCreateData
object
The address data for the created address book entries.
3 properties 2 required
ExternalUpdateWebhookSubscriptionRequest
object
2 properties
ExternalTestNotificationResponse
object
1 property
AddressDeletePayload
object
6 properties 5 required
StandardErrorPayload
object
5 properties
AcceptsMarketing
object
Marketing subscription state for the contact's email.
3 properties
AddressBookEntry
object
An address book entry for a contact.
3 properties
ExternalCreateWebhookSubscriptionRequest
object
2 properties 1 required
ChangeListString
object
Optional; list of event topics that trigger a webhook notification. Possible values include: extension.uninstall, order.create, order.update.
2 properties
ExternalSendTestNotificationRequest
object
1 property 1 required
OrderCreatePayload
object
6 properties 5 required
Email
object
The contact's primary email.
3 properties
ExternalCreateWebhookSubscriptionResponse
object
8 properties 7 required
AddressUpdatePayload
object
6 properties 5 required
ChangeString
object
Optional; HTTPS URL to receive webhook notifications.
2 properties
ExtensionUninstallPayload
object
6 properties 5 required
OrderUpdateData
object
The updated order details.
2 properties 2 required
ExternalRotateSecretResponse
object
1 property
Contact
object
A contact.
7 properties
ContactDeleteData
object
Identifiers and metadata for the deleted contact.
2 properties 2 required
ExtensionUninstallData
object
The extension uninstall details.
1 property 1 required
ContactUpdatePayload
object
6 properties 5 required
ContactAddress
object
Address properties for a contact.
9 properties 1 required
OrderCreateData
object
The created order details.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

squarespace-webhooksubscriptions-api-openapi.yml Raw ↑

Other APIs Squarespace publishes across the network.

Squarespace Orders API
Squarespace Products API
Squarespace Inventory API
Squarespace Profiles API
Squarespace Transactions API
Squarespace Webhook Subscriptions API
Squarespace Site API
Squarespace MCP Server
Squarespace Analytics API
Squarespace Contacts API
Squarespace Discounts API
Squarespace Websites API
Where this information came from

This is an independent, third-party profile of Squarespace Webhook Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.