Set up Shipment Webhook connection
Shipment Webhook is a customer-configured webhook endpoint that receives the results of asynchronous shipment creation requests. Instead of waiting for the shipment to be processed synchronously, SAPIENT immediately returns a Request ID and then sends the completed shipment response (including labels and carrier details) to the customer's webhook endpoint once processing finishes.
This functionality helps reduce API response-time dependency, improve scalability during high-volume periods, and provide greater flexibility for customers who wish to separate shipment creation from downstream label generation, documentation generation, and fulfilment processes
How it works
- The customer calls the Create Shipment Async endpoint.
- SAPIENT performs initial validation and immediately returns a Request ID.
- The shipment is processed in the background.
- Once complete, SAPIENT sends the shipment result to the customer's configured webhook URL. The response can contain successful shipment details, labels, carrier information, or processing errors.
ImportantBefore calling the Create shipment Async endpoint, you must configure the shipment webhook via the SAPIENT UI.
How to set up shipment webhook connection
To set up the shipment webhook connection in SAPIENT, perform the steps as explained in the following procedure.
- 1. Access tracking webhook
- 2. Configure webhook details
- 3. Test your configuration
- 4. Activate and save
See also
Updated about 18 hours ago