Email Triggers

Trigger transactional email notifications for order lifecycle events — acceptance, rejection, results upload, and more.

9 endpoints

Guide

Trigger transactional email notifications for order lifecycle events. These endpoints fire specific email templates to the appropriate recipients (employers, employees, providers) based on order events like acceptance, rejection, results upload, and status changes.

Available Triggers

Each trigger maps to a specific order lifecycle event:

  • orderAccepted/employer — Notify employer when provider accepts an order
  • orderRejected/employer — Notify employer when provider rejects an order
  • orderUpdated/employer — Notify employer when order status changes
  • orderSent/employee — Notify employee when their order is sent
  • orderSent/provider — Notify provider when they receive a new order
  • resultsUploaded/employer — Notify employer when results are available
  • newMessage/employer — Notify employer of new messages on an order
  • employeeNotified/employer — Notify employer that employee was notified
  • employeeConfirmed/employer — Notify employer that employee confirmed appointment

Triggering an Email

Most triggers take an orderItemId (which represents a specific provider portion of an order). Order-level triggers like orderSent/employee take an orderId instead.

Trigger results uploaded notification
Notify employer that results are ready
curl -X POST https://api.bluehive.com/v1/email/trigger/resultsUploaded/employer \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orderItemId": "OI_abc123" }'

# Response:
# { "sent": true, "recipientCount": 3 }

Rate Limiting

Email triggers include built-in rate limiting (HTTP 429) to prevent duplicate notifications. If you receive a 429 response, the notification was already sent recently for that order item.

Email triggers respect employer notification preferences. If an employer has disabled a notification type, the API returns { "sent": false, "reason": "..." } with a descriptive reason.

Chat with Bea