What are the critical components to integrate?
ROOK offers a suite of technological components including SDKs, APIs, and webhooks to facilitate the integration of our services into customer applications. Each component is designed to be modular and can be used independently or in combination with others, depending on the specific requirements of the application.
1. Integration of the Connections page
The Connections page is a web interface designed to be seamlessly integrated into the client's application and is ready for use. Here, users can authorize ROOK to access their health data from various sources.
This module is a straightforward web page featuring a list of data sources and a call-to-action button, where users can initiate each data source's authorization page and grant access to their data. This webpage can be customized in both light and dark themes to match the aesthetics of your application.
It is ideally positioned in the onboarding process for new users, as well as in the profile or settings section within the application.
With this Connections page, you can expedite the development of your application or proof of concept with a ready-to-use solution. In the future, you may choose to retain the page or develop your own application page, or view using our API for data source authorization.
2. API endpoint / Webhook connection
ROOK provides three methods for transmitting the health data supplied: API queries, ROOK Software Development Kits (SDKs), and webhook functionality. This guide will delve into how users can access and effectively utilize these indispensable resources for managing health data and notifications.
API
With our ROOK-Connect API, you can request your user's health data on demand.
To test the API, you'll need your client credentials. Please contact us to obtain them.
To make a request, you'll need the following information:
An api_url
A client_uuid
A client_password
Basic Authentication: Use the client_uuid and client_password as the username and password, respectively.
A user_id
The Health pillar you want to retrieve information from (Sleep, Physical, Body, Mental)
The data type you are requesting (Summary/Event)
The date of the data you want to obtain
Webhooks
With our webhooks, you will be notified when new Health Data Events or Summaries are available for your users.
Notifications Endpoint registration
When you create your account as a client, you'll need to provide us with your REST API endpoint where you want to be notified. If your account is already created, you can contact ROOK support to register or update your endpoint.
Notifications Endpoint characteristics
The endpoint requirements are:
POST method
Without Authorization header
Must respond with 200, 201, or 202 when successfully receiving our notification.
Notifications triggers
Notifications are sent:
For new Events: When new user events are detected:
The Notification speed depends on the Health Data Source technology, so we will:
Send you fast notifications when the Health Data Source notifies us via webhooks.
Check every hour for new Health Data to Health Data Source without webhooks and send you a notification if new Health Data is detected.
For daily Summaries: Every day at 0:00 UTC, we will send your user's summaries for the previous day
Notifications content
The content of the notification depends on the Health Data Pillar which originated the notification. The payload will be one of the three Health Data Pillars and it could be either a Summary or an Event according to the Health Data Structure.
Frequency
ROOK collects, processes, and delivers data to its customers in a timely and reliable manner. The frequency of data collection depends on the type of data being collected.
Events
Events are collected instantly, each time a user completes an event in their data sources. The data is imported, processed, and notified to customers through webhooks or endpoints so that they can access it immediately.
Summaries
Summaries are processed individually for each pillar, once a day. This allows the data collected throughout the day to be imported, processed, and notified to customers through webhooks or endpoints. Summaries are delivered at a set time so that all users can access them at 11:00 AM according to their time zone.
3. (Optional) SDK integration
Choose your SDK framework and explore platform-specific offerings:
Modular: Personalize your app using only the features you require.
Monolithic: Benefit from simplified development with our interconnected modular SDKs.
Explore our comprehensive SDKs designed for distinct platforms: Android native, iOS native, Flutter, and React Native. Expertly crafted to harvest health data from Health Connect and Apple Health, they streamline the transfer of vital statistics to the ROOK servers. Delve into the details in the sections that follow for a closer look at their functionality and integration capabilities.
4. ROOKScore
ROOKScore is a service provided by ROOK that evaluates the health level of your users using health data collected and supplied by ROOKConnect. It provides an easy-to-understand score in the range of 0 to 100, indicating the health status of your users. A score of 0 represents poor health status, while a score of 100 represents excellent health status. Our scoring system is based on global health standards endorsed by the World Health Organization (WHO).
Data Inputs
Activity
Source data: Physical health summaries
Objective: Indicator of the percentage of daily activity achieved by the user
Basic required data: Age, gender, weight, height
Readiness
Source data: Sleep health summaries
Objective: Indicator of the user's cardiac well-being
Basic required data: Age, gender
Sleep
Source data: Sleep health summaries
Objective: Indicator of the quality of the user's sleep
Basic required data: Age
Output Scores
ROOKScore provides several output scores to assess different aspects of the user's health:
Global Score: This score is obtained by averaging the scores obtained in the three health score sections, namely activity, sleep, and readiness.
Activity-Readiness Score: This score is obtained by averaging the scores obtained in the activity and readiness sections, providing an overall assessment of the user's physical activity and cardiac well-being.
Activity-Sleep Score: This score is obtained by averaging the scores obtained in the activity and sleep sections, providing an overall assessment of the user's physical activity and sleep quality.
Readiness-Sleep Score: This score is obtained by averaging the scores obtained in the readiness and sleep sections, providing an overall assessment of the user's cardiac well-being and sleep quality.
These scores give you valuable insights into your users' health status and can be used to track their progress toward their health goals.
Find more information here: