Help CenterHelp Center / Developers · How-to
Send order, return, shipment and customer events from your shop to another system's URL.
A Shop Webhook is a URL that receives a JSON message each time a chosen event happens in your shop. You can add several, each with its own events.
The menu item is Shop Webhooks. The page itself is titled Shop Webhook.
Go to Shop › Shop Webhooks. With no webhooks yet, the page explains the feature and shows Add your first webhook. Otherwise select 1. Add webhook.
The counter beside the heading shows how many are ticked, or Choose at least one. Every event is explained on Webhook events and payloads.
The Returns group shows only when returns are on for your shop. The Shipping group shows only when courier shipping is on. An event that one of your webhooks already uses always stays visible.
Active is on for a new webhook. Select Create webhook.
The What we send card shows the method, the signature header, the reply time allowed and the number of tries. It also shows an example message for the first ticked event.
The form suggests pasting a free test address from a site such as webhook.site, then placing a test order. There is no "send test" button in the panel.
Demo-store orders do not send order or return events.
Each row shows 2. the status badge, Active or Paused, then the URL and 3. one chip per event. A webhook saved with no events shows "No events selected, nothing is sent."
| To | Do this |
|---|---|
| Pause | Select 4. Edit, turn Active off, select Save changes. The row shows Paused and nothing is sent |
| Change the URL or events | Edit, change them, Save changes |
| Delete | Select 5. the bin button and confirm "Delete this webhook? … will stop receiving events." |