Manifest Webhook
a Manifest Webhook is a feature that allows customers to receive real-time notifications about the manifest request. It is used alongside a Manifest Async endpoint, which processes large shipment manifests in the background.
Use the Manifest Webhook to receive near real-time updates when a manifest request changes status or finishes processing.
The webhook sends notifications to your configured endpoint, so you do not need to poll the manifest request status endpoint. This is useful when large batches of shipments take time to process.
Key benefits
- Receive notifications when a manifest request has been processed and manifests have been created.
- Monitor asynchronous manifest requests without repeatedly polling the status endpoint.
- Manage large manifest batches while they process in the background.
ImportantBefore configuring a Manifest Webhook, ensure that a webhook endpoint has been created and authenticated within SAPIENT. Once enabled, manifest status notifications will be delivered automatically whenever a manifest request status changes.
Workflow
After you submit a request to the Manifest Shipments Async endpoint, the system processes it as follows:
- Receives the manifest request and assigns a unique manifestRequestId.
- Processes the request asynchronously in the background.
- Updates the manifest request status during processing.
- Sends a webhook notification when the status changes or processing finishes.
TipIf you need more detail about a manifest request, use its manifestRequestId with the Get Manifest Request Status endpoint. You do not need to poll this endpoint to receive webhook updates.
Getting started
Configure your endpoint to receive notifications about asynchronous manifest processing.
Review webhook suspension behaviour and restore delivery.
Manifest a shipment request using this endpoint for asynchronous processing.
Updated about 1 hour ago