Skip to main content
PUT
Update webhook events

🔄 Update Store Webhook

This endpoint updates the subscribed events for a webhook already registered on the store. Both PUT and PATCH are supported with the exact same request body.

🔐 Authentication

This route requires API Key authentication in the request header:

📥 Path Parameters

📦 Request Body

📋 Request Example

You can also send a PATCH request to the same path (/v1/stores/{storeId}/webhooks) with the same payload.

📊 Response Example (200)

❌ Possible Errors

Authorizations

Authorization
string
header
default:YOUR_API_KEY_HERE
required

Path Parameters

storeId
string
required
Required string length: 1 - 50

Body

application/json

Webhook URL and updated event subscriptions.

events
enum<string>[]
required
Minimum array length: 1
Available options:
store.created,
store.updated,
store.deleted,
store.reordered,
product.created,
product.updated,
product.deleted,
product.reordered,
category.created,
category.updated,
category.deleted,
category.reordered,
coupon.created,
coupon.updated,
coupon.deleted,
coupon.reordered,
page.upserted,
page.deleted,
affiliate.created,
affiliate.updated,
affiliate.deleted,
payment.created,
payment.updated,
payment.deleted,
payment.status.changed
url
string<uri>
required
Required string length: 9 - 200

Response

Webhook updated.

code
string
required
Example:

"WEBHOOK_UPDATED"

events
enum<string>[]
required
Available options:
store.created,
store.updated,
store.deleted,
store.reordered,
product.created,
product.updated,
product.deleted,
product.reordered,
category.created,
category.updated,
category.deleted,
category.reordered,
coupon.created,
coupon.updated,
coupon.deleted,
coupon.reordered,
page.upserted,
page.deleted,
affiliate.created,
affiliate.updated,
affiliate.deleted,
payment.created,
payment.updated,
payment.deleted,
payment.status.changed
webhook
string<uri>
required