Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
conditions
, check out the Event Conditions section to learn how to populate the conditions
field.In case you require an event or a condition that is not yet supported, please send your suggestion to the Zid App Market Support.
Event Name | Description | Payload Schema |
---|---|---|
order.create (Supports conditions ) | Triggered when a new order is created. | Order schema |
order.status.update (Supports conditions ) | Triggered when an order's status is updated. | Order schema |
order.payment_status.update | Triggered when an order's payment status changes to paid or unpaid . Note that unpaid includes pending , refunded , and voided statuses. | Order schema |
Event Name | Description | Payload Schema |
---|---|---|
product.create | Triggered when a new product is created. | Product schema |
product.update | Triggered when a product's details are updated. | Product schema |
product.publish | Triggered when a product is published. | Product schema |
product.delete | Triggered when a product is deleted. | Product deleted schema |
Event Name | Description | Payload Schema |
---|---|---|
abandoned_cart.created | Triggered when a shopping cart is abandoned. | Abandoned Cart schema |
abandoned_cart.completed | Triggered when an abandoned cart is completed. | Abandoned Cart schema |
Event Name | Description | Payload Schema |
---|---|---|
customer.create | Triggered when a new customer account is created. | Customer schema |
customer.update | Triggered when a customer's details are updated. | Customer schema |
customer.merchant.update | Triggered when a merchant's details related to a customer are updated. | Payload |
customer.login | Triggered when a customer logs in. | Customer schema |
Event Name | Description | Payload Schema |
---|---|---|
category.create | Triggered when a new category is created. | Category schema |
category.update | Triggered when a category's details are updated. | Category schema |
category.delete | Triggered when a category is deleted. | Category schema |
conditions
field in the request body allows you to specify additional criteria for your webhook subscription. By setting conditions, you can filter the events that trigger the webhook. For instance, you may want to receive notifications only when an order's status changes to 'delivered' or if the payment method is 'Cash On Delivery'.order.create
and order.status.update
events.Condition Key | Data Type | Description | Possible Values |
---|---|---|---|
delivery_option_id | Integer | The delivery option ID in Zid. | Any valid delivery option ID |
status | String | Filters the event based on the status of the order. | new , preparing , ready , inDelivery , delivered , cancelled |
payment_method | String | Filters the event based on the payment method used. | Cash On Delivery , Credit Card , Bank Transfer |
conditions
field in the request body when creating or updating a webhook subscription. Here's an example:{
"conditions": {
"delivery_option_id": "55",
"payment_method": "Cash On Delivery"
}
}