- Callback Holds
- Get Callback Holds
Callback Holds
Get Callback Holds
List current callback holds by message type
curl --request GET \
--url https://sandbox.masonhub.co/dragonfly-cosmetics-demo/api/v1/callback_holds \
--header 'Authorization: Bearer <token>'Retrieve a list of all current callback holds. Callback holds temporarily suspend the delivery of specific message types to your webhook endpoints.
Callback holds are useful during maintenance windows, system upgrades, or when you need to temporarily pause event delivery without unregistering your webhook endpoints.
This endpoint returns all message types that currently have holds placed on them.
curl -X GET "https://app.masonhub.co/{account}/api/v1/callback_holds" \
-H "Authorization: Bearer your_jwt_token"
{
"holds": [
"skuInventoryChange",
"orderEvent"
]
}
Response Fields
Array of message types currently on hold. An empty array indicates no holds are active.
Common Message Types
The following message types can be placed on hold:
| Message Type | Description |
|---|---|
skuInventoryChange | Inventory level changes for SKUs |
orderEvent | Order status and lifecycle events |
shipmentEvent | Shipment tracking and status updates |
inboundReceived | Inbound shipment receipts |
While holds are active, events are queued but not delivered. When holds are removed, delivery resumes but queued events are not retroactively sent.
Use Cases
Maintenance Windows
Pause callbacks during scheduled system maintenance to avoid failed deliveries.
System Upgrades
Hold events while deploying updates to your webhook processing systems.
Debugging
Temporarily pause events while investigating callback processing issues.
Load Management
Control event flow during high-traffic periods or system stress.
Best Practices
Remember to remove holds after maintenance or debugging is complete. Events that occur during holds are not queued for later delivery.
Check Before Maintenance
Use this endpoint to verify current hold status before beginning maintenance.
Monitor Duration
Keep track of how long holds remain active to avoid missing important events.
Verify Removal
After removing holds, confirm they’re cleared using this endpoint.
curl -X GET "https://app.masonhub.co/{account}/api/v1/callback_holds" \
-H "Authorization: Bearer your_jwt_token"
curl --request GET \
--url https://sandbox.masonhub.co/dragonfly-cosmetics-demo/api/v1/callback_holds \
--header 'Authorization: Bearer <token>'{
"holds": [
"skuInventoryChange",
"orderEvent"
]
}