Webhooks

Webhooks are HTTP callbacks that allow you to push real-time information to other applications in case of certain events e.g. when an order is placed or when a user registers on the site. A Webhook delivers the data immediately as it happens.

Unlike REST APIs where you need to poll very frequently in order to get near real-time data, webhooks provides a much more efficient way to receive real-time data from your store.

APIs and Webhooks are two major ways to integrate third party applications with the Storehippo platform.

Setting up Webhooks

You can create webhooks by going to Advanced Settings > Webhooks in StoreHippo Admin Panel.

Consuming Webhooks

The URL that you specify in the webhook should be able to receive the data from the webhook. The data that is posted will be in the same structure as defined in the corresponding API. For example, webhook for placing an order will receive the JSON data of the Order in the format defined in the API docs.

Events

StoreHippo Currently supports 8 events for the webhooks to listen to

1. Customer Add - a webhook will be sent every time a new customer is created.
2. Customer Update - a webhook will be sent every time a customer record is updated.
3. Customer Delete - a webhook will be sent every time a customer record is deleted.
4. Order Add - a webhook will be sent every time an order is created.
5. Order Update - a webhook will be sent every time an order has been updated.
6. Product Add - a webhook will be sent every time a product has been created.
7. Product Edit - a webhook will be sent every time a product has been updated.
8. Product Delete - a webhook will be sent every time a product has been deleted.

Request

The request sent by StoreHippo would also include some headers:-

X-Storehippo-StoreName - The storename for which the request is made.

X-Storehippo-Entity -  The entity on which for which the request is made.

X-Storehippo-Command - The operation performed on the entity

X-Storehippo-RecordId - The id of the record on which the operation is performed (Only in case of Edit and Delete)