Preview a sample webhook payload
curl --request GET \
--url https://api.byblend.com/api/v1/notifications/sample/{event_code} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.byblend.com/api/v1/notifications/sample/{event_code}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.byblend.com/api/v1/notifications/sample/{event_code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.byblend.com/api/v1/notifications/sample/{event_code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.byblend.com/api/v1/notifications/sample/{event_code}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.byblend.com/api/v1/notifications/sample/{event_code}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.byblend.com/api/v1/notifications/sample/{event_code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}Notifications
Preview a sample webhook payload
Get a sample webhook payload for a given event code. Data in this example is illustrative only.
GET
/
api
/
v1
/
notifications
/
sample
/
{event_code}
Preview a sample webhook payload
curl --request GET \
--url https://api.byblend.com/api/v1/notifications/sample/{event_code} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.byblend.com/api/v1/notifications/sample/{event_code}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.byblend.com/api/v1/notifications/sample/{event_code}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.byblend.com/api/v1/notifications/sample/{event_code}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.byblend.com/api/v1/notifications/sample/{event_code}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.byblend.com/api/v1/notifications/sample/{event_code}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.byblend.com/api/v1/notifications/sample/{event_code}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Event code for the sample payload. Data in this example is illustrative only.
Example:
"order.shipped.SAMPLE"
⌘I