Entity & Event Types:
In eCommerce, each webhook can be associated with a specific Entity Type and corresponding Event Type. The Entity Type represents the resource or object being tracked (e.g., a customer, an order), while the Event Type refers to the specific action that triggers the webhook (e.g., an order being created, a customer being updated). The below table outlines common entity types and their associated event types:
Entity Type | Event Type | Description |
---|---|---|
Company | CompanyCreated | Triggers when a new company is created in the B2B module. |
Company | CompanyUpdated | Triggers when company details are updated in the B2B module. |
Customer | CustomerCreated | Fires when a new customer account is created. |
Customer | CustomerUpdated | Triggers when customer details are updated. |
Customer | CustomerDeleted | Notifies when a customer account is deleted. |
Customer | CustomerNewsletterSubscribe | Notifies when a customer subscribes to newsletters. |
Customer | CustomerNewsletterUnsubscribe | Notifies when a customer unsubscribes from newsletters. |
Orders | OrderCreated | Triggers when a new order is created. |
Orders | OrderApproved | Fires when an order is approved. |
Orders | OrderCancelled | Notifies when an order is canceled. |
Orders | OrderDelivered | Fires when an order is marked as delivered. |
Orders | OrderUpdated | Notifies when the details of an order are updated. |
OrderLines | OrderLineCreated | Triggers when a new order line (individual product in an order) is created. |
OrderLines | OrderLineUpdated | Notifies when an individual order line is updated. |
OrderLines | OrderLineDeleted | Notifies when an order line is deleted. |
Product | ProductCreated | Triggers when a new product is created in the catalog. |
Product | ProductUpdated | Triggers when product details are updated. |
Product | ProductPriceUpdated | Fires when the price of a product is updated. |
Promotion | PromotionCreated | Fires when a new promotion is created. |
Promotion | PromotionUpdated | Notifies when an existing promotion is updated. |
Quotes | QuoteCreated | Notifies when a new quote is created. |
Quotes | QuoteUpdated | Notifies when an existing quote is updated. |
RMA | RMACreate | Fires when a return request (RMA) is created. |
RMA | RMAReceived | Notifies when a return (RMA) is received. |
Store | StoreCreated | Triggers when a new store is created in the system. |
Store | StoreUpdated | Fires when store details are updated. |