Add-ons
The ROOK Connect platform offers multiple add-ons to customize the data integration architecture. Core capabilities such as Time Zone alignment and Data Cleaning are activated by default, while optional ones such as Granular Data extraction, Notification Webhooks, hourly Steps Events, Lab Data, Clinical Ready, Medical Device Metadata, and User Health Profile require manual activation. Pre-Existing Data automatically retrieves up to seven days of historical records for API-based sources on the initial user connection, enabling immediate health metric analysis.
ROOK offers several add-ons that extend the integration experience. Some add-ons are activated by default, while others must be requested. To activate an optional add-on, contact the ROOK support team or your account manager.
| Add-on | What it adds | Activated by default |
|---|---|---|
| Time Zone | Ensures local time delivery | Yes |
| Data Cleaning | Improves data accuracy | Yes |
| Activate Granular Data | Optimizes data delivery | No |
| Notification Webhook | Real-time integration notifications | No |
| Callback URL Setup | Redirects users post-connection | No |
Connections Page Sandbox | Simplifies user authorization | Yes |
| Pre-Existing Data | Historical data retrieval | Yes |
| Steps Events in API | Hourly step polling | No |
| Lab Data | Laboratory document processing | No |
Clinical Ready Beta | FHIR R4 clinical documents | No |
| Medical Device Metadata | Device and regulatory metadata | No |
| User Health Profile | Generated profile with health scores | No |
Health Monitoring Beta | Baseline and threshold alerts | No |
Branded Auth On Hold | A fully personalized experience | No |
Time Zone
The Time Zone add-on ensures that daily summary data is extracted and delivered based on each country’s local time zone.
This add-on is activated by default in ROOK Connect. Additional details are available in the Data Extraction section.
To set up the time zone of your users, check the following endpoint.
Data Cleaning
The Data Cleaning add-on prioritizes and cleans health data from multiple sources for the same user, ensuring the delivery of accurate and comprehensive data structures. This add-on is activated by default in ROOK Connect. For more details, visit the Data Processing section.
Activate Granular Data
The Activate Granular Data add-on enables access to detailed health metrics such as heart rate, heart rate variability, blood pressure, and additional minute-level readings. This option increases payload depth and provides a richer dataset for clients who need more precise insights.
The add-on is not activated by default. More information is available in the Granular Data section.
To activate Granular Data, contact the ROOK support team or your account manager.
Notification Webhook
The Notification Webhook add-on provides real-time updates about integration-specific actions, including user creation, data source connections, and failed notifications. This webhook does not deliver health data, but it provides essential updates for monitoring and troubleshooting.
User management notifications
Notifications are triggered by actions such as:
- New user creation
- Data source connections or disconnections
- Failed data extractions
- Two users of your account connected with the same data source account (version 2 only)
- Data that stopped arriving for a user (version 2 only)
- The delivery of a user's pre-existing data (version 2 only)
For every notice, its fields and the data sources it is available for, see Notices You Can Receive. To see how version 1 and version 2 differ and how to migrate, see Notification Webhook Versions.
Example notification for a user connection
{
"client_uuid": "123456789",
"user_id": "UserTest12345",
"data_source": "garmin",
"action": "user_connected",
"level": "info",
"message": "A new user has been successfully linked",
"action_datetime": "2024-06-03T19:10:43.419390Z",
"environment": "production",
"scopes": null,
"notification_version": 2
}
This example is a version 2 notice. The notification_version field identifies the notice format, and action_datetime is in UTC and ends in Z. Version 1 notices do not include notification_version or scopes, and they are not signed. scopes lists the permissions the user granted, and is null when the data source does not report them.
For the full format and how to verify the signature, see
Verifying the Notification Signature.
For setup guidance, refer to the Data Delivery section.
To activate the Notification Webhook, enable and configure it in the ROOK Portal under Set up > Webhook > Notification Webhook.
Callback URL Setup
The Callback URL Setup add-on enables clients to define a redirect URL for users after completing data source authorization. This add-on improves the user flow by guiding users back to the client’s APP or another designated view.
Usage example:
https://api.rook-connect.com/api/v1/client_uuid/123456789/user_id/UserTest12345/data_sources/authorizers?redirect_url=https://www.yourapp.com
To activate the Callback URL Setup, contact the ROOK support team or your account manager.
Connections Page
The Connections Page simplifies user authorization by presenting a pre-configured interface with buttons for supported data sources. This tool is ideal for sandbox testing and rapid development, but it is not recommended for production environments.