Email Triggers

Trigger Order Updated Email to Employer

Send an email notification to employer admins when an order status changes. Includes optional previous and new status.

post/v1/email/trigger/orderUpdated/employer

Request

Base URL
https://api.bluehive.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/email/trigger/orderUpdated/employer/post.ts
A function with typed inputs. Its response is checked against the schema.

orderItemIdstring required

The OrderItem ID to trigger the email for

previousStatusstring

The previous status of the order item

newStatusstring

The new status of the order item

Default Response

sentboolean required

Whether the email was sent successfully

recipientCountnumber

Number of recipients the email was sent to

reasonstring

Reason why the email was not sent (if sent is false)

Oct 16, 2026a8bcbdf02e33 Revision changes
- info
  endpoint added
Aug 21, 2026ae97a9add0ba Revision changes
- breaking
  api path removed without deprecation