Get order updates with webhooks
A webhook sends a signed message to your server when an order's payment, fulfilment or refund status changes. The project needs the Read permitted orders permission.
Create a webhook
- Open the project and go to the Webhooks tab.
- Select Create webhook.
- Enter the Endpoint URL. It must be a public https address on port 443, with no # part or login details. Redirects aren't followed.
- Select Create webhook.
Copy the Webhook signing secret straight away with Copy signing secret. It isn't shown again. Your server uses it to check that each message came from Shows.
A project can have up to 20 active webhooks in each environment.
Test it
On the webhook's page, select Send test. Shows sends one signed test event and shows whether it was delivered, with the HTTP status and how long it took. Test events aren't recorded in the delivery history.
Check deliveries
The webhook's page shows how many messages were delivered and failed in the last 30 days, and the Delivery history. Open a delivery to see each attempt, the HTTP status, the failure reason and the payload.
Failed deliveries are retried automatically. To send one again yourself, select Retry delivery. The same event is sent again, so your server should ignore events whose ID it has already processed.
Change or stop a webhook
- Edit destination: change the endpoint. Deliveries still being retried go to the new address.
- Rotate signing secret: new deliveries use a new key, so update your server. A delivery already in progress may still use the old one.
- Revoke webhook: stops future deliveries and queued retries. A delivery already in progress may still finish.
Was this article helpful?
