How do I get notified when an order ships?

Blend pushes events to your systems over webhooks. Create a subscription with POST /api/v1/notifications/webhooks, giving it your HTTPS URL and a list of event_codes such as order.created, order.shipped, or order.delivered. Pass "all" to receive everything. You can optionally generate a webhook secret, and Blend will sign every delivery so you can verify it came from Blend.

Webhooks are managed through the API. There is not yet a way to create or edit webhook subscriptions in the Blend Dashboard.

Set it up

See what events exist

curl https://api.byblend.com/api/v1/notifications/events \
  -H "Authorization: Bearer {access_token}"

Each event returns a name, description, and the event_code you subscribe with.

Generate a webhook secret (optional)

curl -X POST https://api.byblend.com/api/v1/notifications/webhook-secret \
  -H "Authorization: Bearer {access_token}"

Optional, but recommended. If you generate one, Blend sends it as Authorization: Bearer {secret} on every webhook delivery, so you can verify the request came from Blend. Without a secret, deliveries are unsigned.

Subscribe your endpoint

curl -X POST https://api.byblend.com/api/v1/notifications/webhooks \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourcompany.com/hooks/blend",
    "event_codes": ["order.shipped", "order.delivered"]
  }'

Test before you rely on it

curl -X POST https://api.byblend.com/api/v1/notifications/sample \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "event_code": "order.shipped",
    "webhook_url": "https://yourcompany.com/hooks/blend"
  }'

This delivers a real, illustrative payload to your endpoint. To inspect the shape without sending anything, use GET /notifications/sample/{event_code}.

What your endpoint has to do

Blend requires your listener to be a valid SSL endpoint that accepts POST and returns a 2xx status code within 10 seconds. Do your real work asynchronously — acknowledge first, process after. Deliveries that fail are retried with exponential backoff.

Every payload carries at minimum an id and a url that deep-links to the relevant record in the Blend Dashboard, so a notification can be turned into a clickable link for your staff with no extra lookup.

Prefer webhooks over polling. If you do poll, filtered list calls (GET /orders?status=shipped) are much cheaper than draining the full order list — see pagination.

Email instead of (or alongside) webhooks

If a human needs to know rather than a system, subscribe to the same event codes by email with PUT /api/v1/notifications/email. Email notifications go to the address on your Blend user profile.

Create a webhook subscription

POST /notifications/webhooks

Get notification event types

GET /notifications/events

Generate a webhook secret

POST /notifications/webhook-secret

Send a sample webhook

POST /notifications/sample

Guides

Getting started

Prescriptions

Patients

Orders

Prescribers

Products and catalog

Reporting and operations

How do I get notified when an order ships?

Set it up

What your endpoint has to do

Email instead of (or alongside) webhooks

Create a webhook subscription

Get notification event types

Generate a webhook secret

Send a sample webhook

​Set it up

​What your endpoint has to do

​Email instead of (or alongside) webhooks

Create a webhook subscription

Get notification event types

Generate a webhook secret

Send a sample webhook

Set it up

What your endpoint has to do

Email instead of (or alongside) webhooks