For the complete documentation index, see llms.txt. This page is also available as Markdown.

List of webhook events

Webhooks are triggered by any changes in the store data, no matter their source. For example, if a new order was placed in the store through REST API call, you still receive the order.created webhook.

Find a full list of available webhook events with the following details below:

  • Webhook event

  • Trigger conditions

  • Access scope required to receive webhooks for this event

  • Link to REST API call allowing you to receive full details about the affected item/entity.

profile.updated

Triggers when any general store settings are updated, for example, selected currency, language, and email notification settings.

Access scope required: read_store_profile

Related REST API call: Get store profile

profile.subscriptionStatusChanged

Triggers when the store subscription plan is changed, for example, the store becomes suspended or the store owner upgrades the plan.

Access scope required: read_store_profile

order.created

Triggers when a new order is placed in the store. Supports both orders made at the checkout and orders created with REST API.

Access scope required: read_orders

Related REST API: Get order

order.updated

Triggers when any order data is updated.

Access scope required: read_orders

Related REST API: Get order

order.deleted

Triggers when an order is deleted from the store.

Access scope required: read_orders

unfinished_order.created

Triggers when a customer leaves an abandoned cart on the storefront.

Access scope required: read_orders

Related REST API: Get abandoned cart

unfinished_order.updated

Triggers when abandoned cart details are changed.

Access scope required: read_orders

Related REST API: Get abandoned cart

unfinished_order.deleted

Triggers when an abandoned cart is deleted from the store.

Access scope required: read_orders

product.created

Triggers when a new product is added to the store.

Access scope required: read_catalog

Related REST API: Get product

product.updated

Triggers when any product details are changed including product stock (quantity available for purchase).

Access scope required: read_catalog

Related REST API: Get product

product.deleted

Triggers when a product is deleted from the store.

Access scope required: read_catalog

category.created

Triggers when a new category is created in the store.

Access scope required: read_catalog

Related REST API: Get category

category.updated

Triggers when any details in an existing category are updated in the store.

Access scope required: read_catalog

Related REST API: Get category

category.deleted

Triggers when a category is deleted from the store.

Access scope required: read_catalog

customer.created

Triggers when a new customer is created. Includes cases when Ecwid automatically creates accounts for new customers when they place an order in the store.

Access scope required: read_customers

Related REST API: Get customer

customer.updated

Triggers when any details of an existing customer are updated in the store.

Access scope required: read_customers

Related REST API: Get customer

customer.deleted

Triggers when a customer is deleted from the store.

Access scope required: read_customers

customer_group.created

Triggers when a new customer group is added to the store through Ecwid admin or API call.

Access scope required: read_customers

Related REST API: Get customer group

customer_group.updated

This triggers when an existing customer group is updated, such as when a new customer is added to it.

Access scope required: read_customers

Related REST API: Get customer group

customer_group.deleted

Triggers when a customer group is deleted from the store. Customers from the deleted group move to a default one.

Access scope required: read_customers

discount_coupon.created

Triggers when a new discount coupon is created in the store.

Access scope required: read_discount_coupons

Related REST API: Get discount coupon

discount_coupon.updated

Triggers when details of any discount coupon are updated in the store.

Access scope required: read_discount_coupons

Related REST API: Get discount coupon

discount_coupon.deleted

Triggers when a discount coupon is deleted from the store.

Access scope required: read_discount_coupons

promotion.created

Triggers when a new promotion (advanced discount) is created in the store.

Access scope required: read_promotion

Related REST API: Search promotions

promotion.updated

Triggers when details of any promotion are updated in the store.

Access scope required: read_promotion

Related REST API: Search promotions

promotion.deleted

Triggers when a promotion is deleted from the store.

Access scope required: read_promotion

product_class.created

Triggers when a new product type is created in the store.

Access scope required: read_catalog

Related REST API: Get product type

product_class.updated

Triggers when details (including attributes) of any product type are updated in the store.

Access scope required: read_catalog

Related REST API: Get product type

product_class.deleted

Triggers when a product type is deleted from the store.

Access scope required: read_catalog

review.created

Triggers when a new product review is created in the store.

Access scope required: read_reviews

Related REST API: Search product reviews

review.updated

Triggers when any review details are updated in the store.

Access scope required: read_reviews

Related REST API: Search product reviews

review.deleted

Triggers when a product review is deleted from the store.

Access scope required: read_reviews

invoice.created

Triggers when a new order tax invoice is generated in the store.

Access scope required: read_invoices

Related REST API: Get tax invoices for order

invoice.deleted

Triggers when an order tax invoice is deleted from the store.

Access scope required: read_invoices

application.installed

Triggers when a new application is installed in the store.

Access scope required: read_store_profile

Related REST API: Get app subscription status

application.uninstalled

Triggers when an app is uninstalled from the store.

Access scope required: read_store_profile

application.subscriptionStatusChanged

Triggers when app subscription status is changed in the store.

Access scope required: read_store_profile

Related REST API: Get app subscription status

application.storageChanged

Triggers when application storage for the app is updated in the store.

Access scope required: read_store_profile

Related REST API: Get all app storage data

customer.personalDataRemovalRequest

Triggers when customers request to remove all personal data from the store.

Access scope required: read_store_profile

Related REST API: Get customer

customer.personalDataExportRequest

Triggers when customers request to share all personal data with them.

Access scope required: read_store_profile

Related REST API: Get customer

profile.personalDataRemovalRequest

Triggers when the store owner requests to remove all personal data from the application.

Access scope required: read_store_profile

Related REST API call: Get store profile

profile.personalDataExportRequest

Triggers when the store owner requests to share all personal data store in the application.

Access scope required: read_store_profile

Related REST API call: Get store profile

Last updated

Was this helpful?