Events

This page covers the events that our Webhooks send.

Webhook Events

Name	Description
`address-anonymized`	Triggered when an existing customer's data is removed from the system at the customer's request.
`address-created`	Triggered when a customer saves a new address.
`address-deleted`	Triggered when a customer deletes an existing address.
`address-updated`	Triggered when a customer updates an existing address.
`customer-anonymized`	Triggered when there is a request made via Panel or Admin API to anonymize a customer.
`customer-created`	Triggered when a new customer is registered or connected via a social network in the checkout application. Note: This only applies to calls made using the Checkout Authentication API and does not work for calls made via the Admin API.
`customer-login`	Triggered on customer login.
`customer-logout`	Triggered on customer logout.
`customer-updated`	Triggered when an existing customer's attributes are extended or modified.
`item-cancelled`	Triggered when there is explicit order item cancelation request via the Account Area or via customer service or by a payment provider.
`item-out-of-stock`	Triggered during order delegation when an item is removed from the order, due to being out-of-stock when delegated to the merchant.
`item-reserved`	Triggered when an item is reserved successfully.
`item-returned`	Triggered when a customer returns one or more packages.
`item-unreservable`	Triggered when an item cannot be reserved, due to being out of stock, and is removed from the order.
`item-unshippable`	Triggered when an item is out of stock and unshippable while the order is being transitioned from “delegated” to “shipped”
`newsletter-subscribed`	Triggered when a customer subscribes to a newsletter during Checkout.
`order-cancelled`	Triggered when all the items of the order are cancelled due to Customer cancellation, Delegation failure or Shipment failu
`order-confirmed`	Triggered when order payment has been successfully completed, and the order is confirmed.
`order-corrective-invoiced`	Triggered when an order or a part of it has been returned, and a corrective invoice is generated.
`order-custom-data-updated`	Triggered when the `legacyCustomData` field on an order or order item is updated
`order-delegated`	Triggered when the order is delegated to the customer.
`order-invoiced`	Triggered when a complete invoice is issued, usually when all packages from a multi-package order are shipped to the customer.
order-partially-invoiced	Triggered when an order is invoiced for some of the items, but not all.
order-pending	Triggered when customer pays, but payment is not captured
`package-shipped`	Triggered when an order package is shipped and the order status transition from “delegated” to “shipped.”
`package-undeliverable`	Triggered when a package cannot be delivered (due to an unidentifiable address, for example) and must be returned to the merchant.
`password-reset`	Triggered on customer password reset.
`payment-capture`	Triggered when a payment capture occurs within an order.
`payment-refund`	Triggered when one or more items are returned.
`VoucherCodeCreationRequest Created`	Triggered when a VoucherCodeCreationRequest is created via API call.
`VoucherCodeCreationRequest Updated`	Triggered when VoucherCodeCreationRequest is updated via API call or during processing by worker.
`product-updated`	Triggered when a product is updated.
`product-master-updated`	Triggered when a product master is updated.
`product-variant-prices-updated`	Triggered when the price for a product variant is updated.
`product-variant-availability-updated`	Triggered when the availability of a product variant updated.
`product-variant-stock-updated`	Triggered when the stock of a product variant is updated.
`shop-category-tree-updated`	Triggered when a shop category tree is updated.