How to receive online shop notifications with webhooks
Create a webhook so BizQ notifies your server with a signed call when an order comes in or is paid, a product or its stock changes, or a customer signs up.
Webhooks let another system (your website, your ERP or an automation) know straight away what happens in your online shop, without having to ask every few minutes.
Create a webhook
- Go to Online shop › Online shop settings and open Webhooks.
- Press New webhook, give it a Name and the Destination URL.
- Tick the Events: new order, order paid, order cancelled, product changed, stock changed (grouped per minute) and new customer (id and email only).
- Press Create webhook and copy the signing secret: it will not be shown again.
- Press Send test to check that your server answers.
Check the signature
Each call carries the headers X-Bizq-Timestamp and X-Bizq-Signature (v1= + HMAC-SHA256 with the secret over the timestamp, a dot and the body). Compute the signature over the body exactly as received and reject timestamps older than 5 minutes.
Keep in mind
- Only https URLs with a public address are accepted; redirects are not followed and BizQ waits at most 5 seconds for the response.
- If a delivery fails it is retried for 24 hours. After 5 days of failures in a row the webhook turns itself off; check the destination and turn it on again.
- Deliveries shows each call, its response and the body sent.
- If you lose the secret, use Rotate secret: the old one stops signing at once.
- There is a maximum of 10 webhooks per store. You need the permission to change the online shop settings.