Skip to main content

Update webhook endpoint

PUT 
/api/v1/sdk/stores/:storeId/webhooks/:webhookId

This endpoint updates an existing webhook endpoint. Supports partial updates - only provided fields are modified.

Authentication: Requires Private API Key (sk_*) with Administer permission

Available Event Types:

Cart Events: cart.created, cart.item_added, cart.item_updated, cart.item_removed, cart.abandoned, cart.recovered, cart.cleared, cart.checkout_started

Order Events: order.created, order.status_updated, order.confirmed, order.shipped, order.delivered, order.cancelled, order.refunded, order.partially_shipped, order.partially_delivered

Customer Events: customer.created, customer.updated, customer.deleted

Product Events: product.created, product.updated, product.deleted, product.inventory_updated, product.variant_created, product.variant_updated, product.variant_deleted

System Events: webhook.test, webhook.endpoint_created, webhook.endpoint_updated, webhook.endpoint_deleted

Currently Active Events: Cart events (created, item_added, item_updated, item_removed, cleared) and Order events (created, status_updated, shipped, delivered) are currently being sent by the system.

Use Cases:

  • Changing webhook URL
    • Adding or removing event subscriptions
    • Temporarily disabling webhooks
    • Updating webhook descriptions

Important Notes:

  • To change secret, use the rotate-secret endpoint
    • Disabled webhooks stop receiving events but are not deleted
    • URL changes take effect immediately

Error Scenarios:

  • 404 NOT FOUND - Webhook or store not found (Error code: WEBHOOK_NOT_FOUND or STORE_NOT_FOUND)
    • 400 BAD REQUEST - Invalid URL or event types (Error code: INVALID_REQUEST)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - Insufficient permissions (Error code: INSUFFICIENT_PERMISSIONS)

Request​

Responses​

Webhook endpoint updated successfully