Handle webhook suspension
Webhook suspension refers to the disabling of the webhook notifications for shipment events due to an error.
If the webhook is suspended, it loses all its tracking data. For example, if a customer reactivates the webhook after one week, they lose one week of the tracking data. Therefore, if you do not want to lose any tracking data, then make sure to activate it promptly.
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.
How webhook suspension works
Suspension Process
When your webhook endpoint is down or encounters errors, SAPIENT follows a structured retry process before suspending the webhook:
- Error Detection: The system detects issues like timeouts, invalid data, or server errors
- Retry Attempts: Multiple retry attempts are made following specific intervals
- Threshold Exceeded: If all retry attempts fail, the webhook is suspended
- Notification: An email is sent to the user registered to receive the suspension notifications. This email can be specified while configuring the Webhook details.
- Retry Loop: When the webhook is suspended, it will be queued to retry again.
ImportantFor shipment webhook, the system will retry the webhook connection for up to 14 days. If the webhook becomes available during this period, the connection will be established automatically. If the webhook remains unavailable after 14 days, the system will stop retrying and the webhook will be suspended.
Retry Schedule
- Manifest and Tracking webhook connection
- Shipment webhook connection
Reactivation Process
To reactivate a suspended webhook:
- Navigate to the webhook configuration in your GUI
- Toggle the Activate switch to enable the webhook
- Monitor the endpoint to ensure it's functioning properly
Best Practices
Prevention
- Implement robust error handling
- Set up monitoring and alerting
- Ensure endpoint reliability
- Test webhook endpoints regularly
Recovery
- Monitor suspension notifications
- Reactivate webhooks promptly
- Verify endpoint functionality
- Check for missed tracking data
See also
Automate the instantaneous flow of information regarding the status of shipments.
Create a shipment request using this endpoint for asynchronous processing.
Enable webhook notifications for manifest-level tracking operations.
Updated 5 days ago