Add-ons

ROOK develops add-ons to enhance your integration experience. Some add-ons are activated by default in our product, while others must be requested. If you require an add-on, please contact your Account Manager.

Add-on	Additional feature	Activated by default
Time Zone	-	Yes
Data Cleaning	-	Yes
Deactivate Granular Data	Yes	-
Notification Webhook	Yes	-
Callback URL Setup	Yes	-

Time Zone

This add-on is activated by default with ROOKConnect. It ensures that each country receives daily summary information according to its local time. For more details on time zones in data collection, refer to this link.

Data Cleaning

This add-on is activated by default with ROOKConnect. It allows for the extraction of health data from multiple data sources for the same user, prioritizing the most reliable sources and performing data cleansing. This process enables the delivery of a more accurate and comprehensive data structure. For more information, refer to this link in Data Collection.

Deactivate Granular Data

Granular data includes specific health metrics such as heart rate, blood pressure, and blood oxygen levels. This detailed information is crucial for conducting in-depth analysis and gaining comprehensive insights into health conditions. For example:

While this detailed information is crucial for in-depth analysis, it can result in large data files that may be challenging for some systems to handle. This add-on optimizes the health data structures delivered via webhooks by omitting granular details, benefiting clients with limited capacity for handling large JSON files. This add-on is available upon request. To access it, contact your Account Manager.

Notification Webhook

The Notification Webhook add-on enables ROOK to send real-time notifications to clients regarding actions within their integration with us. This feature includes notifications for new user creation, connection or disconnection of data sources, failed notifications to user data sources, and undelivered information alerts. Our aim is to provide clients with timely updates without the need for API queries, leveraging webhooks for automatic notifications. This enhancement ensures that clients receive up-to-date information, streamlining their workflows and improving efficiency. This add-on is available upon request. To access it, contact your Account Manager.

User Management

This webhook notifies you whenever a user interacts with the ROOKConnect integration, except for Events and Summaries, which are covered by our Data Webhook. The actions that trigger notifications include:

• New user creation
  • Example JSON:

{
  "client_uuid": "",
  "user_id": "",
  "action": "user_created",
  "level": "info",
  "message": "A new user has been successfully created",
  "action_datetime": "2024-06-10T21:50:28.261548",
  "environment": "production"
}

• New data source linking for a user
  • Example JSON:

{
    "client_uuid": "",
    "user_id": "",
    "data_source": "garmin",
    "action": "user_connected",
    "level": "info",
    "message": "A new user has been successfully linked",
    "action_datetime": "2024-06-03T19:10:43.419390",
    "environment": "production"
}

• Data source unlinking for a user
  • Example JSON:

{
    "client_uuid": "",
    "user_id": "",
    "action": "user_disconnected",
    "level": "info",
    "message": "User has been disconnected from Health Connect",
    "action_datetime": "2024-06-03T19:49:13.504130",
    "environment": "production",
    "data_source": "health connect"
}

Failed User Data Extractions

This notification alerts you when ROOK is unable to extract user event or summary data due to various factors while querying a user's data source. These factors are external to ROOK and may include:

• Data source failures
• Unavailable user information
• Token or credential issues
• Permission problems

Example JSON

{
    "client_uuid": "",
    "user_id": "",
    "data_source": "polar",
    "action": "user_data_extraction",
    "level": "warn",
    "message": "No data found in source",
    "action_datetime": "2024-06-04T12:01:42.896634",
    "environment": "production"
}

Rejected Information

The Rejected Information notification alerts the client when a Data Webhook notification regarding a user event or summary is not accepted. This notification informs the client that the information was not received and allows them to request its delivery if needed.

Callback URL Setup

The Callback URL Setup add-on is for users who connect to a data source via their own Connections Page and need to return to or be redirected to a URL specified by the client. This enhances user flow and retention, allowing clients to segment and personalize subsequent steps in the connection process.

Endpoint Authorizers with feature URL dynamic

{{api_url}}/api/v1/client_uuid/{{client_uuid}}/user_id/{{user_di}}/data_sources/authorizers?redirect_url={{url_client_return}}

Example of URL return of Connections Page:

• With tryrook.io

https://api.rook-connect.dev/api/v1/client_uuid/123456789/user_id/UserTest12345/data_sources/authorizers?redirect_url=https://www.tryrook.io

To access this add-on, contact your Account Manager.

info

The example callback URL for this client uses a demo client_uuid. Since this is public documentation, please do not add any sensitive information to that connection.