Webhooks

Webhooks let the store notify another system the moment something happens, rather than that system having to check for changes. When an event the merchant has subscribed to occurs, the store sends the details to a web address of the merchant's choosing.

This is how a merchant keeps an external system in step with the store in near real time, for example by pushing new orders straight into their accounting or fulfilment software.

Setting Up a Webhook

• Store - the store the webhook listens to.

• Url - the web address the store sends the notification to. This is provided by the receiving system.

• Enabled - whether the webhook is currently active.

• Secret Key - a shared key the receiving system can use to confirm the notification genuinely came from the store.

• Events - the events that trigger the webhook.

An Example Payload is shown for the events selected, so whoever is building the receiving end can see the format of the data before going live.

How to Add a Webhook

1. Click on System at the bottom of the left-hand menu

2. Click on Webhooks

3. Create a new webhook

4. Select the store and enter the url supplied by the receiving system

5. Choose the events that should trigger it

6. Set the secret key and enable the webhook

7. Click Save changes

If the receiving system is not picking up notifications, check that the webhook is enabled and that the url is reachable from outside your network.