Where to find it
Open the organization menu at the bottom of the sidebar, click Manage, then the Webhooks tab. You see your webhooks and an Add webhook button.Add a webhook
1
Open the window
Click Add webhook (or Create your first webhook if the list is empty).
2
Name and address
Enter a Name * and the Endpoint URL *, for example
https://your-server.com/webhooks/zippendo. Use an address that starts with https://.3
Pick the events
Tick the Events * you want, such as Shipment sent or Tracking updated, or click Select all.
4
Save
Click Create webhook. Zippendo now sends each selected event to your address. Your server should answer with a 2xx status quickly, so Zippendo knows the message arrived.
Each message contains the event name, the time and the shipment, order or tracking details. The exact content and how to check the signature are in the Webhooks quickstart.
Securing webhooks
- Signature: Zippendo signs every message with a secret that belongs to the webhook. Your developer uses it to check that a message really comes from Zippendo. The app does not show the secret; a developer reads it through the API (the Get webhook request in the API reference).
- HTTPS: use
https://addresses only, so the messages are encrypted on the way.
Brands
If your organization uses brands, you can give a webhook a brand. It then receives only that brand’s events. A webhook without a brand receives the events of every brand. Set the Brand when you add or edit the webhook.Pause or delete a webhook
- Pause: click Edit on the webhook, untick Active and click Save changes. Zippendo stops sending to that address but keeps the webhook and its Delivery log.
- Delete: click Delete, type the webhook’s name in capital letters and confirm. No more messages are sent to that address, and its Delivery log is removed.