Webhook Overview
AfterShip can send webhook events to notify your system when a particular event has happened. Learn to set up webhooks.
How to setup the Webhooks
You can enable the webhook from the notifications webhooks settings
- Add webhook URL (up to 4)
- Select events to start receiving updates
Securing Webhooks
We currently support either HTTP or HTTPS URLs, so you can have security by using an SSL-enabled URL. But keep in mind that your endpoint is going to be wide-open on the internet, and you might not want others to be able to submit random data to your systems. At this time, aside from trying to keep the URL private, our best advice is to simply include a secret key in the URL that you provide and check the secret GET parameter in your scripts.
Retry Webhooks
AfterShip sends event driven data to webhook URL via POST method. In case of an unsuccessful event (HTTP response code NOT between 200 and 299), AfterShip attempts to deliver your webhooks for up to 14 times with an exponential back off.
The current attempt webhook delay is calculated by this formula: 2^(number of retry) x 30s
# of attempt | # of retry | Delay (sec) before send out | Acc. Delay (sec) |
---|---|---|---|
1 | 0 | 0 | 0 |
2 | 1 | 30 | 30 |
3 | 2 | 60 | 90 |
4 | 3 | 120 | 210 |
5 | 4 | 240 | 450 |
6 | 5 | 480 | 930 |
7 | 6 | 960 | 1890 |
8 | 7 | 1920 | 3810 |
9 | 8 | 3840 | 7650 |
10 | 9 | 7680 | 15330 |
11 | 10 | 15360 | 30690 |
12 | 11 | 30720 | 61410 |
13 | 12 | 61440 | 122850 |
14 | 13 | 122880 | 245730 |
For example, If the attempt fails, AfterShip will retry the 2nd attempt 30s later. If the 7th attempts fail, AfterShip retry the 8th attempt 960s later If the 14th attempts fail, AfterShip will not send out that webhook any more.