Sync Apple Health Data to Home Assistant

Publish health metrics to Home Assistant as separate entity states. This destination supports health metrics only.

Important — automation limitations: Your device must be unlocked to read health data, and iOS does not guarantee background runs at your chosen frequency. Review Automation Limitations before relying on automatic exports.

Open the automation

Open Export → Automated on iPhone, or Automations in the iPad sidebar. Select New Automation, or open an existing automation to edit it.

Name, status, and notifications

Enter a name that identifies this automation. Enabled allows automatic runs; leave it off until you are ready.

Choose any run notifications you want:

• Notify on Cache Update reports that export data was prepared.
• Notify When Run reports a successful publish to Home Assistant.

Allow notifications when prompted. These notifications report activity; they do not schedule a run.

Connect Home Assistant

1. Choose Home Assistant as the Automation Type.
2. Enter the base URL of your Home Assistant instance, such as http://homeassistant.local:8123.
3. Create a Long-Lived Access Token in your Home Assistant profile.
4. Under HTTP Headers, add Authorization with the value Bearer YOUR_LONG_LIVED_ACCESS_TOKEN.

Your Home Assistant instance must be reachable from the iPhone or iPad. For HTTPS, use a certificate your device trusts.

Health Metric Settings

Open Select Health Metrics and choose the readings to publish.

Open Preferred Sources to select sources for each metric. Use All for all non-excluded sources, or Excluded Sources to ignore a source across this automation. Exclusions take precedence, and unselected sources do not replace a preferred source with no data. Select Save to apply the choices or Cancel to discard them.

Export Settings

Home Assistant uses its own JSON entity-state format; there is no file-format or export-version choice.

Date Range

• Default: Includes the previous day and today up to the run time.
• Today: Includes today up to the run time.
• Yesterday: Includes the previous full day.

Time Grouping

Choose Default to keep readings ungrouped or Days to use daily summaries. Home Assistant has no Summarize Data toggle.

Schedule Reminders

If you want a prompt to unlock and open the app, turn on Enable Reminders. Choose Hourly, Every Day, or Selected Days, then set the minute, time, and days as applicable. Allow notification access when prompted; if access is denied, use Open Notification Settings.

A reminder does not run the automation or confirm a successful sync. Tap it to open the automation, or use Open & Sync on the notification to request a run. The automation must be enabled; a reminder may still appear after a successful background run. Reminder changes apply when you save.

Sync Frequency and save

Choose a number and Minutes or Hours under Sync Frequency. This is a desired background cadence, not a guaranteed schedule.

Your device must be unlocked when health data is read. Enable Background App Refresh for Health Auto Export and turn off Low Power Mode for automatic runs. iOS may still delay runs when the device has been inactive or system resources are limited.

Turn on Enabled when you are ready for automatic runs, then select Update to save the automation. You can upload a selected date range immediately using the steps below.

Published entities

Each selected metric can produce one or more entities. The identifier starts with hae., followed by the automation name in lowercase without spaces, then the metric and any component name.

For example, an automation named Health Metrics can publish steps to:

http://homeassistant.local:8123/api/states/hae.healthmetrics_step_count

The state is the latest reading for the selected day, with measurement-unit attributes. Metrics such as blood pressure and heart rate use separate component entities.

When a day has no data, totals such as steps and stand hours publish 0. Other readings, such as weight or heart rate, are not updated until data is available, so Home Assistant may continue showing the last value it received. Early in the day, totals may remain 0 until Watch data reaches your iPhone.

Export historical or missed data

Use Manual Upload when you first set up the automation to export historical data, or later to cover dates missed by automatic syncing. You can also use it to check your setup.

1. Open the automation and select Manual Upload under Export Existing Data.
2. Set the Start and End dates, then select Begin Export.
3. In Home Assistant, open Developer Tools → States and search for your automation’s hae. prefix.
4. Check the entity values and update times.

Troubleshooting

• Authentication error: Check the token and the Authorization: Bearer ... header.
• Connection failed: Check the base URL, port, network access, and certificate trust.
• Some readings missing: Review the selected day, sources, and Activity Logs. A run can update some entities while others fail.

Open the automation and select View Activity Logs to check failed steps. For support, see Getting Help.