Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Event code for the sample payload
Example:
"order.shipped"
Composite Creation
Electronic Prescriptions
Notifications
- GETGet notification event types
- POSTGenerate a webhook secret
- GETGet email subscriptions
- PUTUpdate email subscriptions
- DELDeactivate email subscriptions
- GETGet webhook subscriptions
- POSTCreate a new webhook subscription
- GETGet a webhook subscription
- PUTUpdate webhook subscriptions
- DELDelete a webhook subscription
- POSTSend a sample webhook
- GETPreview a sample webhook payload
- GETDEP: Get subscriptions
- POSTDEP: Create a new subscription
- DELDEP: Deactivate a subscription
Orders
- GETGet orders
- POSTCreate an order
- GETGet an order's details
- PUTUpdate an order
- GETGet shipping options
- GETGet order statuses
- PUTCancel an order
- PUTPause an order
- PUTUnpause an order
- GETGet an order's status history
- GETGet compounding reasons
- POSTCreate a custom compounding reason
- PUTUpdate a custom compounding reason
Patients
Prescribers
- GETGet all available prescribers
- POSTCreate a new prescriber
- GETGet a prescriber's details
- PUTUpdate a prescriber's details
- GETGet all available credentials
- POSTCreate a license/qualification
- PUTUpdate a license/qualification
- DELDeactivate a license/qualification
- GETGet a prescriber's supervisors
- POSTCreate a supervisorial relationship
- DELRemove a supervisorial relationship
- GETGet a prescriber's supervisees
Products and Materials
Reports
Preview a sample webhook payload
Copy
curl --request GET \
--url https://api.byblend.com/api/v1/notifications/sample/{event_code} \
--header 'Authorization: Bearer <token>'Copy
{
"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"
}
}Notifications
Preview a sample webhook payload
Get a sample webhook payload for a given event code
GET
/
api
/
v1
/
notifications
/
sample
/
{event_code}
Preview a sample webhook payload
Copy
curl --request GET \
--url https://api.byblend.com/api/v1/notifications/sample/{event_code} \
--header 'Authorization: Bearer <token>'Copy
{
"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"
}
}⌘I