Webhook Events

Webhook events allow you to subscribe to changes in the state of a prescription or order

Events are our way to letting you know when something interesting happens in your account. When an event occurs, we'll send an HTTP POST request to the URL you specify in your account settings. The request will contain a JSON payload with information about the event.

Your application can verify that Honeybee Health sent the event using the X-Honeybee-Signature header. For more information see Guides/Event Signature Validation.

Event Types

RX_RECEIVED

When a new prescription is received from a prescriber via e-Prescribing, this event is triggered. This event is only triggered for new prescriptions, not refills.

Sample:

{
    "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
    "patient_id": "ay87nt",
    "event_type": "RX_RECEIVED",
    "medication_requests": [
        {
            "id": 183601,
            "prescription_id": 183601,
            "active": true,
            "prescriber_name": "Jane Smith",
            "receive_date": "2019-09-14T13:17:54.906-07:00",
            "drug_name": "IBUPROFEN 800 MG TABLET",
            "ndc": "67877032105",
            "sig_text": "Take 2 tablets by mouth every 8 hours as needed for pain/discomfort.",
            "written_qty": 90,
            "refills_left": 2,
            "expire_date": "2020-09-13T17:00:00.000-07:00",
            "drug_schedule": "0"
        }
    ]
}

RX_UPDATED

This event is triggered when an order status is updated. An example of this is when a prescription is filled and the order status is updated to FILLING.

Sample:

{
  "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  "patient_id": "ay87nt",
  "event_type": "RX_UPDATED",
  "medication_requests": [
    {
      "id": 183601,
      "active": true,
      "receive_date": "2019-09-14T13:17:54.906-07:00",
      "drug_name": "IBUPROFEN 400 MG TABLET",
      "ndc": "62135040012",
      "sig_text": "Take 2 tablets by mouth every 8 hours as needed for pain/discomfort.",
      "written_qty": 90,
      "refills_left": 2,
      "expire_date": "2020-09-13T17:00:00.000-07:00",
      "medication_dispenses": [
        {
          "order_date": "2019-09-14T13:17:54.906-07:00",
          "order_number": "XQ05O2A",
          "order_status": "Filling",
          "order_type": "Verified Order - w/ Rx",
          "product_name": "Motrin",
          "generic_name": "Ibuprofen",
          "manufacturer_name": "Eci",
          "strength": "400 mg",
          "form": "Tablet",
          "package_size": 90,
          "image_url": "https://cdn.honeybeehealth.com/default_product_images/bottle.png",
          "days_supply_dispensed": 15,
          "dispense_id": 414,
          "shipment": null
        }
      ]
    }
  ]
}

SHIPMENT_UPDATED

Where possible, we collect shipment tracking information from the carrier and send over updates.

Sample:

{
  "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  "patient_id": "ay87nt",
  "event_type": "SHIPMENT_UPDATED",
  "medication_requests": [
    {
      "id": 183601,
      "active": true,
      "receive_date": "2019-09-14T13:17:54.906-07:00",
      "drug_name": "IBUPROFEN 400 MG TABLET",
      "ndc": "62135040012",
      "sig_text": "Take 2 tablets by mouth every 8 hours as needed for pain/discomfort.",
      "written_qty": 90,
      "refills_left": 2,
      "expire_date": "2020-09-13T17:00:00.000-07:00",
      "medication_dispenses": [
        {
          "order_date": "2019-09-14T13:17:54.906-07:00",
          "order_number": "XQ05O2A",
          "order_status": "Shipped",
          "order_type": "Verified Order - w/ Rx",
          "product_name": "Motrin",
          "generic_name": "Ibuprofen",
          "manufacturer_name": "Eci",
          "strength": "400 mg",
          "form": "Tablet",
          "package_size": 90,
          "image_url": "https://cdn.honeybeehealth.com/default_product_images/bottle.png",
          "days_supply_dispensed": 15,
          "shipment": {
            "shipment_date": "2019-09-14T16:28:56.487-07:00",
            "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9405511298370701053281",
            "tracking_no": "9405511298370701053281",
            "carrier": "USPS",
            "method": "USPS Priority",
            "latest_shipment_update": {
              "event_code": "NT",
              "description": "In Transit, Arriving On Time",
              "occurred_at": "2019-09-15T09:28:57.000-07:00"
            },
            "shipment_updates": [
              {
                "event_code": "NT",
                "description": "In Transit, Arriving On Time",
                "occurred_at": "2019-09-15T09:28:57.000-07:00"
              },
              {
                "event_code": "OA",
                "description": "Accepted at USPS Origin Facility",
                "occurred_at": "2019-09-14T09:28:57.000-07:00"
              }
            ]
          }
        }
      ]
    }
  ]
}