SQsquarespace
WebhookSubscriptions

Update webhook subscription

Updates information for a webhook subscription. A successful request returns the updated Webhook Subscription resource. Requires an OAuth access token; API keys are not supported. The OAuth token must hold scopes appropriate for each subscribed event topic: order.create and order.update require website.orders or website.orders.read; contact.create, contact.update, contact.delete, address.create, address.update, and address.delete require website.contacts; extension.uninstall requires no event-specific scope.

post/1.0/webhook_subscriptions/{subscriptionId}

Request

Path parameters

subscriptionIdstring required

Specifies the Webhook Subscription to update.

Headers

Authorizationstring required

API key or OAuth access token

User-Agentstring required

User Agent

Request body

Response

OK

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.

Changes

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