Partners API
:::info Partners API Resource Server Details
| Host: | https://partners.honeybeehealth.com |
| Latest Version | V1 |
| • Base path: /v1 | |
| • API Reference: Version 1 Reference |
:::
Introduction
Honeybee Health Partners API is a modern, RESTful API-driven Pharmacy as a Service. The Honeybee Health Partners API uses resource-oriented URLs, supports HTTPS transport and OAuth 2.0 authorization and leverages JSON in all responses.
This documentation provides a reference on how to integrate with Honeybee Health's Partners API. This API allows for partners to manage and get data on prescriptions and orders.
Before consuming the Partners API, please make sure you have read the documentation on Authentication & Authorization, and understand how to authenticate and receive access tokens to authorize use of this API.
Honeybee supports multiple workflows and will work with partners to help them select the best one for their needs. Honeybee’s goal is always to make sure patients are happy and well taken care of, while supporting an efficient and simple workflow for our partners.
Supported Partners API Workflows
Honeybee supports two integration workflows. The right choice depends on how much control you need over when a prescription is filled.
| API Driven (Partner Requested Fills) | Automatic Processing | |
|---|---|---|
| Order created when | You call POST /orders | Automatically on Rx receipt |
| Best for | Filling after payment, eligibility, or internal checks | Fastest possible integration |
| Refills | Reuse one prescription_id across many orders | New e-Rx required per order |
| Setup effort | Moderate | Minimal |
API Driven (Partner Requested Fills)
For the most control over when a prescription is filled, the Partner Requested Fills workflow intakes e-Prescriptions without creating an order automatically. Honeybee fires an RX_RECEIVED webhook on intake; you match the patient, complete any pre-fill steps (payment, eligibility), then call POST /orders when you're ready. Subsequent order, shipment, and exception webhooks flow back to you throughout the order lifecycle.
:::tip Start here The API Integration Guide is a complete, step-by-step walkthrough of this workflow — from your first prescription to live order tracking, including sandbox testing. It's the recommended starting point for new integrations. :::
Related references: Matching Event Data to Patients · Events · API Reference.
Automatic Processing
The Automatic Processing workflow is the fastest way to get integrated.
When Honeybee receives an e-Prescription; patient, shipping, medication and prescriber data is extracted and an order is automatically created and the filling/verification process begins. Orders can be viewed on the Orders Dashboard
With the Automatic Processing workflow, partners still have the option of adding a webhook URL where Honeybee Health can send updates for orders and shipments. Please see the Events documentation for more information.