Unreal Engine quickstart

Before you begin

Use Unreal Engine 5.8. The base HealthBridge plugin is required. The separate HealthBridge Real-Time Heart Rate plugin is only for owned companion-watch live sessions.

Install and configure

1. Install HealthBridge from Fab into the Unreal Engine project.
2. In Edit > Plugins, enable HealthBridge, then restart the editor.
3. Complete Tools > HealthBridge > Setup Wizard. It saves project settings in DefaultGame.ini; unlike Unity, it does not create settings assets.
4. Open Tools > HealthBridge > Permissions and choose only the types your game reads or writes. The same configuration is at Project Settings > Plugins > HealthBridge.

For a safe first check, select Tools > HealthBridge > Samples > Create Blueprint Examples or Create Health Data Review Sample, then press Play. The editor uses a mock provider, so this confirms the plugin and your settings without accessing a player’s health records.

Use Blueprint

The HealthBridgeSubsystem is a game-instance subsystem. Get it from the game instance, call Auto Initialize, and bind its completion and assignable events. The generated Blueprint examples demonstrate initialization, workouts, enum-backed reads, routes, heart-rate monitoring, write/delete flows, and the optional real-time add-on path.

Prefer the enum-backed data-type inputs for built-in types. Use a raw type ID only when you deliberately support a custom or future registry entry.

Use C++

UHealthBridgeSubsystem is the Blueprint-friendly facade. C++ code may use FHealthBridgeService directly; callbacks run on the game thread.

#include "HealthBridgeService.h"

FHealthBridgeService::AutoInitialize([](bool bReady)
{
    UE_LOG(LogTemp, Log, TEXT("HealthBridge ready: %s"),
        bReady ? TEXT("true") : TEXT("false"));
});

To read steps, create FHealthDataQuery(TEXT("steps"), 7, 100) and call FHealthBridgeService::ReadData. For workouts, use GetRecentWorkouts; for a route, use GetWorkoutRoute with the imported workout ID. Treat routes as an optional capability: the platform can decline them because of support or consent.

Verify before a device build

1. In PIE, confirm the sample reports provider=Mock and displays data.
2. Save the selected permission rows in Project Settings.
3. Prepare platform configuration with the mobile setup guide.
4. Validate on a physical iOS or Android device.

Do not log raw callback payloads or health identifiers in shipped builds. See troubleshooting for common setup failures.