Webhook suspension
Webhook suspension refers to the disabling of the webhook notifications for shipment events due to an error.
If the receiving endpoint (the system where the notifications are sent) is down or encounters errors, for example, time out, invalid data, SAPIENT may suspend sending further webhook notifications to avoid overwhelming the system.
If the threshold value for retrying the webhook within the given intervals is exceeded, then the webhook is suspended and a corresponding email is sent to the primary user registered for the customer. A primary user is set up at the time of customer onboarding. If you want to change the primary user, you can contact Intersoft's onboarding team.
Tip
The webhook can beactivated via the GUI.
The retry intervals for the webhook are provided in the following table.
| ShipmentTrackingStatusRetryIntervalId | RetryCount | IntervalInMinutes |
|---|---|---|
| 1 | 0 | 5* (see below) |
| 2 | 1 | 10 |
| 3 | 2 | 15 |
| 4 | 3 | 30 |
| 5 | 4 | 300 (5 hours) |
| 6 | 5 | 1080 (18 hours) |
| 7 | 6 | 1440 (24 hours) |
| 8 | 7 | 1440 (24 hours |
Important
Once the webhook is suspended, it looses all its tracking data. For example, if a customer reactivates the webhook after one week, they loose one week of the tracking data. Therefore, if you do not want to loose any tracking data, then make sure to activate it promptly.
A list of possible error codes are explained in the following table.
Error Code | Error description | Details |
|---|---|---|
400 | Bad Request | Occurs when the server cannot understand the request. This can happen when there is a simple error in the request. |
401 | Unauthorized | Occurs when the request was not successful as it lacks valid authentication credentials for the requested resource. |
402 | Payment Required EXPERIMENTAL | Occurs when the payment has not gone through. To resolve this, client must make a payment to access the requested resource. |
403 |
| Occurs when you do not have permission to access a web page or something else on a web server. |
410 | Gone | Occurs when the requested resource is permanently unavailable on the server. This is due to the resource that has been intentionally removed or retired and will not return. |
413 | Payload Too Large | Occurs when the size of the request exceeds the server’s file size limit. |
414 | URL/URI Too Long | Occurs when the requested URL (or URI) is longer than the server can interpret or process. |
415 | Unsupported Media Type | Occurs when the payload format is not supported by the server. |
416 | Range Not Satisfiable | Occurs when the partial range request sent by the client does not make sense for the given resource. |
417 | Expectation Failed | Occurs when the server or something in its response process does not support the conditions in the ‘Expect’ header. This error indicates that the server could not do what was asked in the ‘Expect’ header of a request. |
418 | I'm a teapot | N/A |
501 | Not Implemented | Occurs when the web server does not support the facility required. This is not something you can resolve as it requires a fix from the web server admin. |
505 | HTTP Version Not Supported | Occurs when the server does not recognize or support the HTTP protocol version specified in the client’s request. |
506 | Variant Also Negotiates | Occurs when there is an issue with the server. |
510 | Not Extended | Occurs when the server requires additional extensions to fulfil a request. |
511 | Network Authentication Required | Occurs when the client's attempt to authenticate to gain network access fails. |
Tip
It is a good practice to have a dedicated monitoring for the webhook so that you can be notified when it starts returning the errors.
Updated 2 days ago