WebhookSubscriptions

Get webhook subscription

Retrieves information for a specific webhook subscription. Requires an OAuth access token; API keys are not supported.

get/1.0/webhook_subscriptions/{subscriptionId}

Request

Base URL
https://api.squarespace.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/squarespace/apis/commerce-api/docs/1.0/webhook_subscriptions/:subscriptionId/get.ts
A function with typed inputs. Its response is checked against the schema.

subscriptionIdstring required

Specifies the Webhook Subscription to retrieve.

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

clientIdstring

Third-party client id.

createdOnstring

ISO 8601 UTC date and time string; represents when the webhook subscription was created.

endpointUrlstring

HTTPS URL that receives webhook notifications.

idstring

Unique Webhook Subscription id.

topicsstring[]

List of event topics that trigger a webhook notification. Possible values include: extension.uninstall, order.create, order.update.

updatedOnstring

ISO 8601 UTC date and time string; represents when the webhook subscription was last modified.

websiteIdstring

Unique website id.

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