Connect data sources

Integration of Thryve SDK takes barely more than a few minutes to connect data sources up and running including native data sources.

Assuming you have set up your mobile app project as outlined and have added the Thryve SDK via dependency management or manually via framework files, you have everything to get going to get your users to connect their data source with your application.

All data connections and data stored at Thryve are always linked to a Thryve user. A Thryve user will be automatically created or an existing user will be retrieved when initializing the SDK.

Initialize the Thryve SDK

Create the ThryveSDK instance using getOrCreate and set up the ThryveSDKConfig object according to your needs. Initializing ThryveSDK will automatically create a new Thryve user or get an existing Thryve user based on endUserAlias.

import ThryveCore
import ThryveCommons
import ThryveObservability
import ThryveAppleHealth
import ThryveShenAI
import ThryveBLE

let appleHealthConfig = ThryveAppleHealthConfig(
    dataTypes: ThryveAppleHealthDataType.allConnectorTypes,
    enableBackgroundSync: true // `true` by default
),

let thryveSDKConfig = ThryveSDKConfig(
    authId: "AUTH_ID",
    authSecret: "AUTH_SECRET",
    endUserAlias: "YOUR_UNIQUE_USER_IDENTIFIER",
    endUserId: nil, 
    locale: "de",
    configs: [appleHealthConfig, shenAIConfig, bleConfig],
    observability: ObservabilityConfig(tracingEnabled: true,              crashReportingEnabled: true)
)
        
let thryveSDK = await ThryveSDK.getOrCreate(thryveSDKConfig)

// Optionally, when ThryveSDK is initialized from a non-async context (AppDelegate, legacy code, etc.), it is recommended to use the getOrCreate(...) callback to know when the SDK is ready.

ThryveSDK.getOrCreate(thryveSDKConfig) { initResult in
    if initResult.successful {
        Logger.i("ThryveSDK ready, you can start calling API methods")
    } else if let error = initResult.errors?.first {
        Logger.e("ThryveSDK init failed: \(error.errorMessage ?? "Unknown error")")
    }
}

import com.thryve.sdk
import com.thryve.sdk.commons
import com.thryve.sdk.healthConnect
import com.thryve.sdk.samsungHealth
import com.thryve.sdk.shenAI
import com.thryve.sdk.ble

val healthConnectConfig = ThryveHealthConnectConfig(
        dataTypes = ThryveHealthConnectDataType.entries.toList(),
        enableBackgroundSync = true,
        enableReadHealthDataHistory = true
    )

val samsungHealthConfig = ThryveSamsungHealthConfig(
        dataTypes = ThryveSamsungHealthDataType.entries.toList()
    )
   
val shenAIConfig = ThryveShenAIConfig(
    apiKey = "SHEN_AI_API_KEY",
    eventsListener = object : ThryveShenAIEventListener {
        override fun onEvent(event: ThryveShenAIEvent) {
            when (event) {
                ThryveShenAIEvent.MEASUREMENT_FINISHED -> { /* Shen AI measurement has finished and is about to be uploaded */}
                ThryveShenAIEvent.MEASUREMENT_FAILED -> { /* Shen AI measurement has failed - handle failure */}
                ThryveShenAIEvent.DATA_UPLOAD_FINISHED -> { /* Shen AI has finished uploading data */}
                ThryveShenAIEvent.DATA_UPLOAD_FAILED -> { /* Shen AI has failed uploading data */}
                ThryveShenAIEvent.USER_SUMMARY_FINISHED -> { /* The Shen AI flow has been completed */ }
            }
        }
    }
 )
    
val thryveSDKConfig = ThryveSDKConfig(
    authId = "ASSIGNED_AUTH_ID",
    authSecret = "ASSIGNED_AUTH_SECRET",
    endUserAlias = "XXXXXXXXXXX",
    endUserId = null, 
    locale = "de",
    healthConnectConfig = healthConnectConfig,
    samsungHealthConfig = samsungHealthConfig,
    shenAIConfig = shenAIConfig,
    bleConfig = bleConfig
)
                 
val thryveSDK = ThryveSDK.getOrCreate(thryveSDKConfig, context)

/**Android SDK 5.0.5 introduced an optional callback to communicate the status 
  of internal processes of getOrCreate. ThryveSDK instance can now be created 
  with a callback as shown in the sample code below.  
**/
val thryveSDK = ThryveSDK.getOrCreate(thryveSDKConfig, context) { thryveResponse ->
       if(thryveResponse.successful){
           //ThyveSDK initialization processes completed successfully
       } else {
           // ThryveSDK initalization process failed. process the ThryveErrors for the specific reason.
           thryveResponse.errors.map { thryveError -> Logger.e(TAG){" getOrCreate ThryveError in onCreate function $thryveError"} }
       }
  }

import {
  Source,
  ThryveSamsungHealthDataType,
  ThryveHealthConnectDataType,
  ThryveAppleHealthDataType,
  ThryveSDK
} from '@thryve/thryve-react-native-sdk';

const samsungHealthDataTypes = Object.values(ThryveSamsungHealthDataType);
const appleHealthDataTypes = Object.values(ThryveAppleHealthDataType);
const healthConnectDataTypes = Object.values(ThryveHealthConnectDataType);

export default (authId = AUTH_ID, authSecret = AUTH_SECRET) => {
  const thryveSDK = new ThryveSDK();
  const thryveSDKConfig = {
    authId: appId,
    authSecret: appSecret,
    endUserAlias: "YOUR_UNIQUE_USER_IDENTIFIER",
    locale: 'en',
    config: [
      {
        source: Source.APPLE,
        dataTypes: appleHealthDataTypes,
      },
      {
        source: Source.HEALTH_CONNECT,
        dataTypes: healthConnectDataTypes,
        enableBackgroundSync: true,
        enableReadHealthDataHistory: true,
      },
      {
        source: Source.SAMSUNG,
        dataTypes: samsungHealthDataTypes,
      },
      {
        source: Source.SHENAI,
        apiKey: "SHEN_AI_API_KEY",
      },
    ],
  };
  thryveSDK.getOrCreate(thryveSDKConfig);
  return thryveSDK;

import 'package:module_apple_health/module_apple_health.dart';
import 'package:module_health_connect/module_health_connect.dart';
import 'package:module_shealth/module_shealth.dart';
import 'package:module_shen_ai/module_shen_ai.dart';

import 'package:thryve_sdk/thryve_sdk.dart';

final class ThryvePageBloc {
  late ThryveSDK _thryveSDK;
  
  ThryvePageBloc() {
    _thryveSDK = injector<ThryveSDK>();
    _thryveSDK.init(
      ThryveSDKConfig(
          authId: 'ASSIGNED_AUTH_ID',
          authSecret: 'ASSIGNED_AUTH_SECRET',
          endUserAlias: 'XXXXXXXXXXX',
          locale: 'en',
          healthConnectConfig: ThryveHealthConnectConfig(
            dataTypes: HealthConnectDataType.values,
            enableBackgroundSync: true,
            enableReadHealthDataHistory: true,
          ),
          samsungHealthConfig: ThryveSamsungHealthConfig(
            dataTypes: SHealthDataType.values,
          ),
          appleHealthConnectConfig: ThryveAppleHealthConfig(
            dataTypes: HKConnectorType.values,
          ),
          shenAIConfig: ThryveShenAIConfig(apiKey: 'SHEN_AI_API_KEY')),
    );
  }
  
}

There are two versions of ThryveSDK singleton initialization. Synchronous ThryveSDK.getOrCreate() and asynchronous await ThryveSDK.getOrCreate(). It is recommended to use async version when providing new config using ThryveSDK.getOrCreate(newConfig) to ensure ThryveSDK awaits user refresh safely

Parameter

Description

Mandatory

context

default Android context (only relevant for Android integration)

yes

authId

Credentials to authorize your app with the Thryve backend

yes

authSecret

Credentials to authorize your app with the Thryve backend

yes

ThryveSDK.getOrCreate throws a fatalError and an InitializationException on iOS and Android respectively, that must be handled in your code. Starting from Android SDK 5.0.5, InitializationException is handled internally in the SDK and communicated in a ThryveResponse to the host application via an optional callback

Create a Thryve user

The SDK will automatically take care of creating new users. It will also take care of managing existing users when endUserAlias is set. Therefore we highly encourage usage of endUserAlias as otherwise you will need to manually manage and set the endUserId for existing users. You can retrieve the endUserId of the current user using getEndUserId method.

Parameter

Description

Mandatory

endUserAlias

Unique identifier for your user that can be set optionally by you. Make sure to set a secure, non-predictable, unique identifier without personal identifiable information.

Maximum length is 80 characters, only alphanumeric characters and dash (-) are supported.

endUserId

Identifier used to authenticate your end-user with Thryve in network requests. Only set if you don't use the endUserAlias and want to initialize the SDK for an existing user.

With the introduction of Thryve SDK 5.0.0 former accessToken has been renamed to endUserId and partnerUserId has been renamed to endUserAlias for improved clarity. Functionality of parameters has not changed.

To avoid iOS SDK race conditions on endUserId refresh, please, use async version of ThryveSDK.getOrCreate() singleton init. Additionally, iOS SDK provides .endUserIdDidUpdate notification implementation to catch endUserId updates if needed: NotificationCenter.default.addObserver(forName: .endUserIdDidUpdate, ...)

Set user language

The configured language is used in the UI provided by Thryve, like the Thryve Connection Widget. If not manually set by your app, the SDK will use the language set on the device.

Parameter

Description

Mandatory

locale

Manually set the language code following ISO 639-1 to set the language that will be used on UI elements, e.g. the Thryve Widget. If empty the SDK will get the phone's language.

Thryve Connection Widget allows your end users to connect and disconnect all enabled data sources configured for your application without you needing to implement any views or logics.

The Thryve Connection Widget will be launched as a web-view and can be implemented within any view of your application by using ThryveDataSourceConnectionWidget.

struct DataSourceConnectionView: View {
    var body: some View {
        VStack(spacing: 16.0) {
            // 1. Option without a response
            ThryveDataSourceConnectionWidget()
                .frame(maxWidth: .infinity, maxHeight: .infinity)
                .clipped()
                
            // 2. Example using callback closure
            ThryveDataSourceConnectionWidget { response in
                Logger.i {
                    "Data source connection response: success=\(response.successful), data=\(response.data ?? false)"
                }
                if let error = response.errors?.first {
                    Logger.e { "Connection error: \(error.errorMessage ?? "")" }
                }
            }
            .frame(maxWidth: .infinity, maxHeight: .infinity)
            .clipped()
            
            // 3. Or using SwiftUI binding
            ThryveDataSourceConnectionWidget(responseBinding: $connectionResponse)
                 .frame(maxWidth: .infinity, maxHeight: .infinity)
                 .clipped()
                 .onChange(of: connectionResponse) { response in
                     if let response = response {
                         Logger.i { "Binding response: \(response.successful)" }
                     }
                 }
        }
        .navigationBarTitle("Data Sources", displayMode: .inline)
    }
}

@ViewBuilder
private func mainView() -> some View {
        VStack(alignment: .center, spacing: 16.0) {
             NavigationLink(
                  destination: DataSourceConnectionView()
             ) {
                  Text("Connection Widget")
             }
            .modifier(ButtonModifier())
        }
}

//OPTION 1: adding ThryveDataSourceConnectionWidget in code.
lifecycleScope.launch {
    try {
        val view = ThryveDataSourceConnectionWidget.build(activity, "showthryve://com.thryve.sample")
        withContext(Dispatchers.Main.immediate) {
            binding.dataSourceWidgetLayout.addView(view)
        }
    } catch (e: Exception) {
        withContext(Dispatchers.Main.immediate) {
            Toast.makeText(activity, "Unable to load data source connection widget: ${e.message}", Toast.LENGTH_LONG).show()
        }
    }
}

//OPTION 2: adding ThryveDataSourceConnectionWidget in your layout
<LinearLayout
  android:id="@+id/widget_layout"
  android:layout_width="match_parent"
  android:layout_height="wrap_content"
  android:orientation="vertical">

   <com.thryve.sdk.widget.ThryveDataSourceConnectionLayout
        android:id="@+id/thryve_data_source_widget_layout"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:redirectURL="showthryve://com.thryve.sample"
        android:orientation="vertical"
         android:padding="5dp" />

</LinearLayout>

// Using Android Compose
AndroidView(
    factory = { ctx ->
        try {
            ThryveDataSourceConnectionWidget.build(
                activity = ctx as ComponentActivity,
                redirectUrl = "showthryve://com.thryve.sample",
            )
        } catch (e: Exception) {
            TextView(ctx).apply {
                text = "Unable to load data source connection widget: ${e.message}"
            }
        }
    }
)

import React from 'react';
import {ScrollView} from 'react-native';
import {ThryveDataSourceConnectionView} from '@thryve/react-native-sdk';

const DataSourceConnectionWidgetScreen = () => {
  return (
      <ScrollView>
        <ThryveDataSourceConnectionView redirectURL=""  height={'100%' } width={'100%' }/>
      </ScrollView>
  );
};


export default DataSourceConnectionWidgetScreen;

import 'package:auto_route/auto_route.dart';
import 'package:flutter/material.dart';
import 'package:thryve_sdk/thryve_sdk.dart';

@RoutePage<void>()
class ThryveDataSourceConnectionPage extends StatefulWidget {
  const ThryveDataSourceConnectionPage({
    super.key,
    this.redirectUrl = 'showthryve://com.thryve.sample',
  });

  final String redirectUrl;

  @override
  State<ThryveDataSourceConnectionPage> createState() => _ThryveDataSourceConnectionPageState();
}

class _ThryveDataSourceConnectionPageState extends State<ThryveDataSourceConnectionPage> {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Thryve Data Source Connection'),
      ),
      body: ThryveDataSourceConnectionWidget(redirectUrl: widget.redirectUrl),
    );
  }
}

Apple Health, Health Connect, and Samsung Health will be shown in the Thryve Connection Widget only if their respective modules are imported and the data source is available on the device.

Parameter

Description

Mandatory

redirectURL

To automatically redirect users after connection or disconnection of web data sources, we recommend configuring a deep link. The specified redirectURI should link the user to the screen where Thryve Connection Widget is embedded within your application

no. applicable to only native, react native and Flutter Android SDKs

Module configuration options

Data source configuration

When using optional SDK modules like for Apple Health, Health Connect or Samsung Health , make sure to initialize the corresponding configurations ThryveAppleHealthConfig, ThryveHealthConnectConfig and ThryveSamsungHealthConfig for correct functionality.

Parameter

Description

Mandatory

configs

List of ThryveSDKModulesConfig for imported SDK modules.

yes

When using the Apple Health module, make sure to define the data types in the ThryveAppleHealthConfig . This is only relevant for iOS integration.

Parameter

Description

Mandatory

dataTypes

The Apple Health data types Set<ThryveAppleHealthDataType> required by your app. Ensure to limit types to data described in your data privacy policy. Please refer to this document to understand the data types.

yes

enableBackgroundSync

Configures background data synchronization on SDK initialization (retrieving data when your app is closed or idle). Default state is true which requires Background Delivery to be enabled for a HealthKit Capability.

Alternatively, use the executeBackgroundSync method in AppDelegate

For details on configuring the ThryveBLE and ThryveShenAI modules, refer to their respective documentation pages.

Observability configuration

To continuously improve the performance and stability of the Thryve SDK, the framework reports telemetry data like crashes and traces to Thryve's observability backend. Developers can configure what telemetry data is sent to Thryve using the ObservabilityConfig object.

Parameter

Description

Default

tracingEnabled

When true, information on performance and errors linked to a Thryve user is reported to Thryve's observability backend. Requires import of ThryveObservability module.

crashReportingEnabled

When true, crashes caused by the ThryveSDK will be reported anonymously to Thryve's observability backend.

true

Observability data is fully handled by Thryve's own infrastructure and never shared or processed with any 3rd party, ensuring the highest degree of data privacy for your end users.

The ThryveObervability module is only available for iOS.

Overview of data shared with Thryve when crash reporting or tracing is enabled

The following data is processed by Thryve when observability functions are enabled:

Crash reporting

When crash reporting is enabled, the following information is sent to Thryve's self-operated observability backend in the event of an app crash:

crash stack trace
app information
- authId
- bundle id
- state (inactive/active)
- version
device information
- model name
- operating system
- operating system version
- memory size
- free memory
session information
- app start time
- app uptime
- app time in foreground
- timestamps on actions performed by the SDK, e.g. initialization, execution of methods etc.

Crash reports are anonymous and no IP information or other unique identifiers are collected

Tracing

When tracing is enabled the following information is sent to Thryve's self-operated observability backend:

app information
- authId
- bundle id
- state (inactive/active)
- version
device information
- model name
- operating system
- operating system version
- memory size
user information
- endUserId
process (trace) information
- success true/false
- ThryveErrors
- start/endTimestamp of process
- process parameters (e.g. requested HealthKit types, requested timeframes etc.)
- process metadata (e.g. number of processed data points)

PreviousFlutter NextBuild your custom data source connection screen

Last updated 21 days ago

hashtagInitialize the Thryve SDK

hashtagCreate a Thryve user

hashtagSet user language

hashtagDisplay the Thryve Connection Widget

hashtagModule configuration options

hashtagData source configuration

hashtagObservability configuration

hashtagCrash reporting

hashtagTracing

Initialize the Thryve SDK

Create a Thryve user

Set user language

Display the Thryve Connection Widget

Module configuration options

Data source configuration

Observability configuration

Crash reporting

Tracing