curl --request POST \
--url https://api.byblend.com/api/v1/notifications/sample \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"event_code": "order.shipped",
"webhook_url": "https://example.com/webhook"
}'
{
"event_code": "order.shipped",
"payload_preview": {
"carrier": "USPS",
"created_at": "2025-07-31T17:13:13.520283",
"estimated_delivery_date": "2025-07-31T17:13:13.520651",
"service_level": "Ground Advantage",
"status": "received",
"tracking_number": "9200190347375200504724",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200504724",
"updated_at": "2025-07-31T17:13:13.520304",
"url": "http://localhost:3000/shipments/46aaf265-60bb-4c34-bc08-be20e1628412"
},
"message": "Sample webhook sent successfully",
"webhook_url": "https://example.com/webhook"
}
Send a sample webhook for testing integrations
curl --request POST \
--url https://api.byblend.com/api/v1/notifications/sample \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"event_code": "order.shipped",
"webhook_url": "https://example.com/webhook"
}'
{
"event_code": "order.shipped",
"payload_preview": {
"carrier": "USPS",
"created_at": "2025-07-31T17:13:13.520283",
"estimated_delivery_date": "2025-07-31T17:13:13.520651",
"service_level": "Ground Advantage",
"status": "received",
"tracking_number": "9200190347375200504724",
"tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200504724",
"updated_at": "2025-07-31T17:13:13.520304",
"url": "http://localhost:3000/shipments/46aaf265-60bb-4c34-bc08-be20e1628412"
},
"message": "Sample webhook sent successfully",
"webhook_url": "https://example.com/webhook"
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Successful response with sample webhook details
The response is of type object
.