API Reference

🔔 Konvex Webhooks Subscription

This endpoint (POST /core/api/webhooks) allows you to subscribe a single callback URL to receive real-time notifications about key events occurring across your e-commerce platforms.

By unifying events under consistent names, we simplify integration, regardless of the source platform (Shopify, WooCommerce, VTEX).


🎯 Unified Event List and Platform Availability

Use the Unified Event name for the topics field in your request body. The table below indicates whether the event is available on the corresponding platform.

Orders (orders & refunds)

Unified Event Shopify WooCommerce VTEX
orders.createdAvailableAvailableAvailable
orders.updatedAvailableAvailableAvailable
orders.paidAvailableAvailableAvailable
orders.fulfilledAvailableN/AAvailable
orders.partially_fulfilledAvailableN/AN/A
orders.cancelledAvailableAvailableAvailable
refunds.createdAvailableAvailableN/A

Fulfillment Management (fulfillment_orders)

Unified Event Shopify WooCommerce VTEX
fulfillment_orders.request_submittedAvailableN/AAvailable
fulfillment_orders.request_acceptedAvailableN/AAvailable
fulfillment_orders.cancellation_submittedAvailableN/AN/A
fulfillment_orders.cancelledAvailableN/AN/A

Checkouts and Draft Orders

Unified Event Shopify WooCommerce VTEX
checkouts.createdAvailableN/AN/A
checkouts.updatedAvailableN/AN/A
draft_orders.createdAvailableN/AN/A
draft_orders.updatedAvailableN/AN/A

Customers (customers)

Unified Event Shopify WooCommerce VTEX
customers.createdAvailableAvailableN/A
customers.updatedAvailableN/AN/A
customers.deletedAvailableN/AN/A
customers.tags_addedAvailableN/AN/A
customers.purchasing_summaryAvailableN/AN/A

Products and Inventory

Unified Event Shopify WooCommerce VTEX
products.createdAvailableN/AN/A
products.updatedAvailableAvailableN/A
products.deletedAvailableN/AN/A
inventory_levels.updatedAvailableN/AN/A

App Lifecycle

Unified Event Shopify WooCommerce VTEX
app.uninstalledAvailableN/AN/A
Language
Credentials
Header
Click Try It! to start a request and see the response here!