🪝
Webhooks
Get notified
Getting super powers
WebHooks are an architectural pattern that allows third-parties and developers to subscribe to Zid events, so whenever an event is triggered in a specific store, all activated and authorized webHooks will be called.
We follow Rest hooks standards, please read their documentation to understand how WebHooks work in Zid.
Use cases
✅ Listen for something status ( order status, product update, etc...)
✅ Send supported events only once you create WebHook
✅ Use conditions, but if there is none, send null rather than empty array
⛔️Send API requests in infinite loop to get something status, use WebHooks.
⛔️Send API requests based on time (setTimeInterval, sleep, etc...), use WebHooks.
⛔️Not deleting your un needed WebHooks.
Events
We provide set of events on the main region of interest of any store, products and orders, here is a list of events supported:
Event
Source
order.create
Order
order.status.update
Order
product.create
Product
product.update
Product
product.publish
Product
Product.delete
Product
Conditions
Once you register your WebHook event, you can also provide some conditions
order.create events
Key
Type
Description
delivery_option_id
integer
the delivery option id in Zid
payment_method
string
one of these statues [Cash On Delivery, Credit Card, Bank Transfer]
order.status.update
Key
Type
Description
delivery_option_id
integer
the delivery option id in Zid
payment_method
string
one of these statues [Cash On Delivery, Credit Card, Bank Transfer]
status
string
one of these statues [new, preparing, ready, indelivery, delivered, cancelled]
For now we do not have conditions for other events, however, we are working hard to build conditions for other events
Last modified 8mo ago
Copy link