Webhooks allow you to receive real-time events regarding the delivery of your packages.It's critical to use webhooks as opposed to polling the API for continuous updates in order to avoid exceeding our rate limits.Add/Update/Delete Webhooks#
You can manage your webhooks from our dashboard settings page:Triggers#
You can set your webhooks on each status change or use a single webhook for all of them. Please find the list of trigger statuses below:| # | Trigger Name |
|---|
| 1 | order new |
| 2 | order scheduled |
| 3 | order out_for_collecting |
| 4 | order collecting (active) |
| 5 | order collected |
| 6 | order received_warehouse |
| 7 | order sorted |
| 8 | order transferred_carrier |
| 9 | order received_carrier_warehouse |
| 10 | order in_transit |
Authentication#
Webhook validation headers can be used to validate that the webhooks we send actually come from us. To set this use Boxy's dashboard to add any header to the webhooks in order to secure them.Each time we send a webhook we will then include this key-value pair which can be used to validate where the webhooks come from.Public IPs#
Please note that we recommend you to rely on DNS resolution rather than IP whitelisting to successfully receive webhooks events. Modified at 2025-02-06 14:25:39
