Help Center HealthyApps
English
Help Center
Main website ↗

Search help topics

Heart Rate Notifications - JSON Export Format

Documentation for heart rate notifications structure in JSON exports

Last updated: October 31, 2026

On this page
Structure
Fields Fields Required FieldsOptional Fields
Heart Rate DataRelated Documentation

Heart Rate Notifications include high and low heart rate alerts from Apple Watch, irregular rhythm notifications, and heart rate samples collected during these events. In JSON exports, heart rate notifications are stored in the heartRateNotifications array.

Structure

Each notification includes event timing, an optional threshold (for high/low notifications), source information, and quantity-series heart rate samples between the event start and end:

{
  "heartNotification": "high_heart_rate_notification",
  "start": "2024-02-06 14:30:00 -0800",
  "end": "2024-02-06 14:35:00 -0800",
  "threshold": 100,
  "source": {
    "name": "Apple Watch",
    "identifier": "com.example.recorder"
  },
  "heartRateData": [
    {
      "qty": 105,
      "units": "count/min",
      "start": 1707258600,
      "end": 1707258605
    }
  ]
}

Fields

Required Fields

  • heartNotification (String): Notification type identifier
  • start (Date): Start time of the heart rate notification event in format yyyy-MM-dd HH:mm:ss Z
  • end (Date): End time of the heart rate notification event in format yyyy-MM-dd HH:mm:ss Z
  • source (Object): Device/source that recorded the notification
    • name (String): Human-readable source name
    • identifier (String): Source bundle identifier
  • heartRateData (Array): Heart rate quantity samples during the event window (see Heart Rate Data below)

Optional Fields

  • threshold (Number): Heart rate threshold that triggered the notification. Only included for high and low heart rate notifications.

Heart Rate Data

The heartRateData array contains quantity-series heart rate measurements during the notification event window. Each sample contains qty, units, start, and end:

{
  "qty": 105,
  "units": "count/min",
  "start": 1707258600,
  "end": 1707258605
}

Fields:

  • qty (Number): Heart rate value
  • units (String): Unit of measurement (typically "count/min")
  • start (Number): Start of the measurement period as Unix epoch seconds
  • end (Number): End of the measurement period as Unix epoch seconds