Webhooks
Add Webhook to Store
Adds a new webhook to the store, respecting the plan limit.
POST
Add webhook to store
➕ Add Webhook to Store
This endpoint allows adding a new webhook URL to the store, respecting the maximum limit allowed by the plan.🔐 Authentication
This route requires authentication via API Key, sent in the request header:📥 Route Parameters
📥 Request Body
📋 Request Example
📊 Response Example (200)
Update events (PUT/PATCH): You can also sendPUTorPATCH /v1/stores/{storeId}/webhookswith{ "url": "...", "events": [...] }(at least 1 valid event required) to update the events of an existing webhook; on success, returns200withcode: "WEBHOOK_UPDATED","webhook", and"events"(or404 WEBHOOK_NOT_FOUNDif the URL is not registered).
❌ Possible Errors
Body
application/json
Webhook URL and optional event subscriptions.
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 Response
Webhook added.
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