---
title: "Update webhook subscription"
method: POST
path: "/1.0/webhook_subscriptions/{subscriptionId}"
tags: ["WebhookSubscriptions"]
---

# Update webhook subscription

`POST /1.0/webhook_subscriptions/{subscriptionId}`

## Request

- Base URL: `https://api.squarespace.com`
- URL: `https://api.squarespace.com/1.0/webhook_subscriptions/{subscriptionId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/squarespace/apis/commerce-api/docs/1.0/webhook_subscriptions/:subscriptionId/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `subscriptionId` string, required

## Headers

- `Authorization` string, required
- `User-Agent` string, required

## Request body

- ExternalUpdateWebhookSubscriptionRequest
  - `endpointUrl` ChangeString: Optional; HTTPS URL to receive webhook notifications.
    - `present` boolean
    - `value` string
  - `topics` ChangeListString: Optional; list of event topics that trigger a webhook notification. Possible values include: extension.uninstall, order.create, order.update.
    - `present` boolean
    - `value` string[]

## Response `200`

OK

- ExternalWebhookSubscriptionResponse
  - `clientId` string: Third-party client id.
  - `createdOn` string: ISO 8601 UTC date and time string; represents when the webhook subscription was created.
  - `endpointUrl` string: HTTPS URL that receives webhook notifications.
  - `id` string: Unique Webhook Subscription id.
  - `topics` string[]: List of event topics that trigger a webhook notification. Possible values include: extension.uninstall, order.create, order.update.
  - `updatedOn` string: ISO 8601 UTC date and time string; represents when the webhook subscription was last modified.
  - `websiteId` string: Unique website id.

## Other responses

- `400`: The request body does not conform to the required specification.
- `404`: The requested Webhook Subscription was not found.

---

[API](https://skmtc.dev/squarespace/apis/commerce-api.md) - [All operations](https://skmtc.dev/squarespace/apis/commerce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/squarespace/apis/commerce-api/revisions/5dd4b1b7cd38?raw)
