Webhooks Overview
Webhooks are a technology that notifies integrated applications of events occurring inside the platform so different applications can stay in sync. When specific events happen in your store, Ideasoft sends an HTTP POST notification to your registered address — no API polling required.
Only changed fields are sent
Webhook bodies contain only the fields whose values changed. If you need other data, you are expected to call the API using the reported id.
Webhook record properties
A webhook record consists of the following properties:
topic: The event that triggers the webhook.address: The target URL the POST request is sent to when the event occurs.status: The webhook status.created_at: When the webhook record was created.updated_at: When the webhook record was last updated.
fields
The fields property (which let you choose the fields returned) was removed in V8.
Supported events
create, update and delete events are defined for 15 entities (some entities support a subset):
| Entity | Topics |
|---|---|
Brand (brand) | brand/create, brand/update, brand/delete |
Category (category) | category/create, category/update, category/delete |
Subscription Contract (contract) | contract/create, contract/update, contract/delete |
Extra Preferences (extra_pref) | extra_pref/update |
Member (member) | member/create, member/update, member/delete |
Member Group (member_group) | member_group/create, member_group/update, member_group/delete |
Order (order) | order/create, order/update, order/delete |
Order Refund Request (order_refund_request) | order_refund_request/create, order_refund_request/update, order_refund_request/delete |
Product (product) | product/create, product/update, product/delete |
Payment (payment) | payment/create, payment/update, payment/delete |
Theme (theme) | theme/create, theme/update, theme/delete |
Queue Process (queue_process) | queue_process/create, queue_process/update |
Mail List (maillist) | maillist/create, maillist/update, maillist/delete |
Currency (currency) | currency/update |
Price Rule (price_rule) | price_rule/create, price_rule/update, price_rule/delete |
Every topic follows the entity/event format; e.g. order/create or product/update.
Field lists
See the Webhook Reference for the current list of fields carried by each topic.
Request envelope
The body always uses the same envelope format:
Code
For delete topics the body mostly contains only id (a few topics carry extra fields).
Continue: Managing Webhooks · Security · Delivery