Skip to main content
POST
/
api
/
v1
/
notifications
/
sample
Send a sample webhook
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"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
event_code
string

Event code for the sample payload

Example:

"order.shipped"

​
webhook_url
string

URL of the your listener URL to receive the webhook

Example:

"https://example.com/webhook"

Response

200 - application/json

Successful response with sample webhook details

​
event_code
string

Event code as provided

Example:

"order.shipped"

​
payload_preview
object

Preview of the webhook payload

​
message
string
Example:

"Sample webhook sent successfully"

​
webhook_url
string

URL of the webhook that received the event

Example:

"https://example.com/webhook"