Webhook suspension

Webhook suspension refers to the temporary pausing or 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.

A list of possible error codes are explained in the following table.

Error CodeError descriptionDetails
400Bad RequestOccurs when the server cannot understand the request. This can happen when there is a simple error in the request.
401UnauthorizedOccurs when the request was not successful as it lacks valid authentication credentials for the requested resource.
402Payment Required EXPERIMENTALOccurs when the payment has not gone through. To resolve this, client must make a payment to access the requested resource.
403Forbidden (Unauthorized)Occurs when you do not have permission to access a web page or something else on a web server.
410GoneOccurs 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.
413Payload Too LargeOccurs when the size of the request exceeds the server’s file size limit.
414URL/URI Too LongOccurs when the requested URL (or URI) is longer than the server can interpret or process.
415Unsupported Media TypeOccurs when the payload format is not supported by the server.
416Range Not SatisfiableOccurs when the partial range request sent by the client does not make sense for the given resource.
417Expectation FailedOccurs 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.
418I'm a teapotN/A
501Not ImplementedOccurs 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.
505HTTP Version Not SupportedOccurs when the server does not recognize or support the HTTP protocol version specified in the client’s request.
506Variant Also NegotiatesOccurs when there is an issue with the server.
510Not ExtendedOccurs when the server requires additional extensions to fulfil a request.
511Network Authentication RequiredOccurs when the client's attempt to authenticate to gain network access fails.

🚧

Important

If the webhook is suspended, an email is sent out to the the customer account linked to the tracking webhook.