Send a sample webhook

Send a sample webhook for testing integrations. This will include the webhook secret in the Authorization header if a secret has been set. Data in this example is illustrative only.

POST /api/v1/notifications/sample

Send a sample webhook

cURL

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.SAMPLE",
  "webhook_url": "https://example.com/webhook"
}
'

200

{
  "event_code": "order.shipped.SAMPLE",
  "payload_preview": {
    "carrier": "USPS",
    "created_at": "2025-07-31T17:13:13.520283",
    "external_id": "my-id-128318AA2",
    "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
    "order_number": "ORD250312003548IAU4",
    "shipped_at": "2025-07-31T17:13:13.520304",
    "service_level": "Ground Advantage",
    "status": "shipped",
    "tracking_number": "9200190347375200504724",
    "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9200190347375200504724",
    "updated_at": "2025-07-31T17:13:13.520304"
  },
  "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. Thee

Example:

"order.shipped.SAMPLE"

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.SAMPLE"

payload_preview · object

Preview of the webhook payload

Show child attributes

message · string

Example:

"Sample webhook sent successfully"

webhook_url · string

URL of the webhook that received the event

Example:

"https://example.com/webhook"