Skip to main content

Quick Start Guide

Welcome to ROOK, your trusted partner for effortlessly collecting and analyzing health data from an extensive range of sources. With our solutions, you can seamlessly integrate data from multiple devices using our user-friendly SDKs or APIs. The data you collect is readily accessible via webhook notifications or direct APIs queries. Additionally, ROOK's innovative Score, derived from the analyzed data, enables you to create detailed health profiles for your users.

In this guide, we'll show you how to quickly set up your integration with ROOK. By the end of this guide, you will be able to register users and receive their data through our webhooks and APIs queries.

Integration Guide​

This section provides a step-by-step guide to help you integrate with ROOK and start collecting your users' health data efficiently.

Portal

ROOK Client Portal​

The Client Portal is your starting point for a successful integration of ROOK. Create an account and start setting up all necessary configurations to make the most out of your ROOK experience. For additional guidance, feel free to reach out to our Customer Success team.

Dashboard frame.png

Account Creation​

To start using ROOK, you need to create an account on the ROOK Portal. You will be asked to provide specific details about yourself and your company during registration.

After completing all the required fields, you will have successfully registered and can proceed to configure your integration with ROOK.

note

Required data includes:

  • Email address
  • Password
  • Company name
  • Company industry
  • Name of the person leading this project
  • Role in the company
  • Estimated number of users of your digital solution
  • Company logo (optional)

Account Setup​

Setting up your account is straightforward and involves three key steps.

Generate Your Credentials​

The first step is to generate your credentials, which will provide you with your Client UUID and Secret Key.

Portal

info

Your secret key can only be generated once and should be saved/downloaded to your computer. If you need a replacement or lose it, generating a new one is possible; however, this should not become a frequent practice.

Configure Your Connections Page​

This step allows you to customize your Connections Page in the following ways:

  • Connections Page URL: Enter a URL to test and preview your Connections Page.
  • Style of your Connections Page: Choose between a Light or Dark theme.
  • Data Sources Available: Select the data sources you want to work with. These will appear on your Connections Page.
note

For this quick start, we provide a connections page intended solely for use in your Sandbox environment. You will need to develop your own connections page to enhance the user experience once your integration progresses to the Production environment.

Portal

Setup For Receiving Webhooks & API Queries​

Configure your system to receive data on new events and user summaries:

  • Via Webhooks (recommended option): Receive instant notifications for new events and summaries as they happen.
  • Through API Queries: Access event and summary data directly from ROOK using our API queries. Further details can be found in our repository.

data-webhooks.png

Connecting Your Users​

Note: The instructions provided here are specific to API-based data sources. For SDK-based data sources, please adhere to the guidelines detailed in each SDK's documentation. The next crucial step in integrating ROOK is to establish a centralized hub for user authentication. This hub facilitates the launching of authentication pop-ups for various data sources. If your users are connecting to multiple data sources, this page will serve as a unified interface showcasing all data source buttons along with their respective connection statuses.

Initiate Connection​

Begin the connection process by displaying a list of data sources on the Connections Page, each represented by an interactive button. Users will review and agree to the terms and conditions associated with each data source, and then grant ROOK authorization to access their data.

Quick Start with ROOK Demo Connections Page​

For initial testing and setup, you may use the ROOK Demo Connections Page. This demo provides options to:

  • Adjust the color scheme
  • Configure which data sources are displayed This page is intended to demonstrate the customization possibilities within your own application. Please note that this demo is designed for demonstration purposes only and is not suitable for use in production environments. Learn more about how to develop and tailor your own Connections Page here.

Creating Your Own Connections Page for Production​

For production deployment, you must develop your own web-based or app-based Connections Page. We provide endpoints that facilitate this customization, enabling you to:

  • Retrieve URLs for the authentication buttons
  • Obtain descriptions and icons for each data source
  • Monitor and display connection statuses This step is mandatory because the demo Connections Page is not available in a production environment. Creating your own Connections Page ensures that it is fully integrated and operational within your application, maintaining consistency with your branding and meeting your specific functional requirements.

DS.png

Data Reception​

Once your users have successfully linked their data sources, you will automatically receive their data through our webhook each time new data is received. Alternatively, you can query this data using our APIs.

Empower Your Application​

Congratulations! You are now ready to enhance your mobile or web application with ROOK's powerful data integration capabilities.