Skip to main content

QuickStart Guide

Description​

Discover the comprehensive ROOK guide to seamlessly integrating and analyzing health data. Learn how to utilize ROOK's APIs and SDKs to collect data, configure webhooks for real-time notifications, and ensure a smooth production deployment.

Prerequisites​

Team requirements for ROOK integration​

To successfully integrate ROOK, your organization will need the following teams based on your application’s needs:

Backend team​

  • Receive data: Build an API on your end to receive health data sent by ROOK.
  • Data storage and processing: Store the data securely on your servers for further processing.
  • Serve your app: Develop an API to serve your end-user application.

Frontend team (optional)​

  • Custom connections pages: Create a user-facing page that allows your users to authorize access to their health data.
  • Dashboards: Build user-friendly dashboards or interfaces to present health information to end users in a clear and actionable format.

Mobile team (if needed)​

ROOK integrates with two types of data sources: API-based and mobile-based. Learn more about supported sources in Data Sources.

  • If interested in mobile-based data sources:
    • Use the ROOK Extraction App: This ready-to-use app collects data from Apple Health and Health Connect, requiring no mobile development but offering neutral branding.
    • Develop a custom mobile app: If the client has an existing app or wishes to create one with personalized branding and features, a mobile team will be needed to integrate ROOK’s SDKs for Apple Health and Health Connect data collection.

Data Sources and Testing​

Once you’ve identified the data sources that align with your project goals (e.g., Fitbit, Garmin, Apple Health), it’s highly recommended to:

  • Obtain devices or accounts for the target data sources to test and validate the integration process.
  • Ensure test users have existing data: Having a few users with wearables from your selected data sources can greatly aid testing. Ideally, these users should have some days of health data already logged.

ROOK supports the extraction of pre-existing data from connected sources. For more details, see Data Sources.

To successfully integrate ROOK into your solution, you’ll need to establish a basic architecture that supports receiving, storing, and serving health data. Here’s a high-level overview:

  1. Data Reception:

    • You’ll need to create an endpoint (such as a webhook URL) in your backend to receive data from ROOK.
    • ROOK delivers data primarily via webhooks for real-time updates or daily summaries.

  2. Data Storage:

    • Store the data received from ROOK in your own system or cloud infrastructure. This ensures you can manage, process, and analyze the data as needed for your business use case.

  3. Backend Development:

    • Your backend will:
      • Receive and store the data from ROOK.
      • Process the data as needed.
      • Serve the data to your end-user applications (web or mobile).

  4. Frontend or Application Integration:

    • If you have a mobile app:

      • You can integrate ROOK’s SDKs to extract data from mobile-based sources (e.g., Apple Health, Health Connect).
      • Alternatively, you can use the ROOK Extraction App, a ready-to-use solution for mobile-based data sources.

    • If you have a web app:

      • Your backend should serve the stored data to the web app, allowing you to display health metrics or provide actionable insights.

    • To connect users to health data sources, build your connectios web page or app view using ROOK APIs.

Integration Steps​

The integration process is divided into sandbox testing and production implementation.

Overview​

  1. Create an account on the ROOK Portal.
  2. Test in sandbox environment:
    • Generate credentials.
    • Configure data sources.
    • Set up webhooks.
    • Connect users.
    • Validate data flow.
  3. Transition to production:
    • Request production enablement.
    • Configure production environment.
    • Connect users.
    • Start receiving live data.

Step 1: Create Your Account​

The ROOK Portal is your central hub for integration. Once registered, you can:

  • Generate credentials for sandbox and production environments.
  • Configure data sources, webhooks, and endpoints.
  • Monitor integration performance.

Required Information​

  • Email and password.
  • Company name, sector, and optional logo.
  • Project lead’s name and role.
  • Estimated number of users.

ROOK Portal Dashboard

Step 2: Test in Sandbox Environment​

The sandbox environment allows you to test your integration without impacting live users.

2.1: Generate Credentials​

Navigate to the Credentials section in the ROOK Portal to generate your Client UUID and Secret Key.

info
  • Your Secret Key is displayed only once. Store it securely.
  • Sandbox and production credentials are separate.

Credentials.png

2.2: Configure Data Sources​

ROOK integrates with two types of data sources:

API-Based Sources​

  • Platforms like Fitbit, Garmin, and Oura.
  • Use the /authorizers endpoint to build a custom Connections Page.
  • For sandbox, use the pre-configured Connections Page for quick testing.

Mobile-Based Sources​

  • Use ROOK SDKs to integrate health data into your app.
  • Alternatively, deploy the ROOK Extraction App for immediate use.

Connection_page.png

2.3: Set Up Webhooks​

Configure Data Webhooks in the ROOK Portal to receive real-time updates.

Steps:​

  1. Provide a secure URL for POST requests.
  2. Test payloads using tools like Webhook.site.
note
  • Webhooks are recommended for real-time updates.
  • Use the API for specific queries or debugging. Learn more in Data Delivery.

Webhook.png

2.4: Connect Users​

Users must authorize ROOK to access their health data:

  • API-Based Sources:

    • Use the sandbox Connections Page for testing.
    • Build a production-ready page using the /authorizers endpoint for production.
    • Learn more in Data Authorization.

  • Mobile-Based Sources:

    • Use the ROOK Extraction App or integrate SDKs into your app.

Connect Users

2.5: Validate Data Flow​

Once users are connected, ROOK delivers health data via:

  1. Webhooks for real-time updates.
  2. API for occasional on-demand queries.

Refer to Data Types for schemas and validate the data during testing.

Step 3: Transition to Production​

After validating your sandbox integration, transition to the production environment.

3.1: Request Production Enablement​

Contact ROOK Support to enable your production environment. This step ensures readiness and prevents accidental misconfigurations.

3.2: Configure Production Environment​

Repeat the sandbox steps for production:

  1. Generate production credentials.
  2. Configure production data sources and webhooks.
  3. Validate configurations with production data.

3.3: Connect Users​

  • API-Based Sources:

    • Build a production-ready Connections Page using the /authorizers endpoint.
    • Ensure alignment with branding and security requirements.

  • Mobile-Based Sources:

    • Use the ROOK Extraction App or integrate SDKs into your app.

3.4: Start Receiving Live Data​

Monitor data flow in production to ensure consistency and reliability:

  • Use Webhooks for real-time updates.
  • Use the API for specific queries or data verification.

Conclusion​

ROOK’s QuickStart Guide provides the foundation for seamless integration:

  1. Create an account on the ROOK Portal.
  2. Test in sandbox to validate workflows.
  3. Transition to production for live data delivery.

For further details and advanced features, explore: