Installation

npm install scatesdk-react

Android Integration

To ensure that the ScateSDK works properly on Android, you need to add the Maven repository to your build.gradle file. This wrapper version uses com.scate:scatesdk:7.0.11 or newer for Adjust integration and parameterized events.

In your project's android/build.gradle file, add the following Maven repository:

repositories {
        // Other repositories
        maven {
            url "https://europe-west1-maven.pkg.dev/mavenrepo-433814/scatecoresdk-android"
        }
    }

⚠️ Attention ⚠️

In your android/app/build.gradle file, under buildTypes, please add the following lines:

buildTypes {
    release {
        minifyEnabled false
        shrinkResources false
    }
}

Note: If you enable minifyEnabled (code shrinking and obfuscation) in your build.gradle, you must keep ScateSDK classes to avoid issues with JSON serialization (such as @SerializedName fields turning into random letters).

To do this, add the following to your proguard-rules.pro file:

-keep class com.scatesdkreact.** { *; }
-keepclassmembers class com.scatesdkreact.** { *; }

iOS Integration

This wrapper version uses ScateSDK 7.0.10 or newer and Adjust 5.6.1 or newer for Adjust integration. Add NSUserTrackingUsageDescription to the iOS app Info.plist if you want ScateSDK to request App Tracking Transparency authorization.

If CocoaPods reports that the Swift pod scatesdk-react depends on Adjust and Adjust does not define modules, add Adjust as a modular header in the app Podfile:

pod 'Adjust', '~> 5.6.1', :modular_headers => true

Usage

Initialize the SDK

import { ScateSDK } from 'scatesdk-react';

ScateSDK.Init('your app id');
ScateSDK.InitAdjust('your adjust token');

ScateSDK.GetAdjustId((adid) => {
  // ADID is non-empty here.
});

By default, on iOS, InitAdjust configures Adjust with a 120 second ATT consent wait interval and requests App Tracking Transparency authorization at init time. Add NSUserTrackingUsageDescription to the iOS app Info.plist for the prompt to appear. Pass noATT: true to skip ScateSDK's ATT request path:

ScateSDK.InitAdjust('your adjust token', { noATT: true });

When an ADID is resolved, ScateSDK stores it as the SDK ADID and sends scate_adjust_id once after ScateSDK is initialized. If your app already initializes Adjust, avoid calling InitAdjust a second time; keep your app-owned Adjust setup and call ScateSDK.GetAdjustId(...) after Adjust is ready, or continue to use ScateSDK.SetAdid(adid).

By default, on iOS, when Firebase Analytics is linked and configured in the host app, ScateSDK sets Firebase user_id to the Scate user ID during initialization. If your app already manages Firebase user_id, disable this before initialization:

ScateSDK.Init('your app id', {
  firebaseUserIdSyncEnabled: false,
});

Send Events

To send events, you can use the following code:

ScateSDK.Event('button_clicked');

Send Events with Parameters

Pass a dictionary as the optional second argument to Event. These values are sent as event parameters.

ScateSDK.Event('button_clicked', {
  screen: 'paywall',
  position: 1,
  isPrimary: true,
});

Send Events with Additional Data

Use this only when you need the legacy customValue field.

ScateSDK.EventWithValue('button_clicked', 'subscribe_btn');

Send Events with a Custom Value and Parameters

Send a customValue and a parameters dictionary together in a single event.

ScateSDK.EventWithValueAndParameters('result', 'grade_changed', {
  grade: 'PSA10',
});

Get Remote Config for Key

ScateSDK.GetRemoteConfig('key', 'defaultValue');

Add Listener

ScateSDK.AddListener(ScateEvents.REMOTE_CONFIG_READY, (event) => {});

Remove Listener

ScateSDK.RemoveListener(ScateEvents.REMOTE_CONFIG_READY);

Clean Listeners

ScateSDK.CleanListeners(ScateEvents.REMOTE_CONFIG_READY);

Onboarding Event Functions

ScateSDK.OnboardingStart();
ScateSDK.OnboardingStep('location_screen');
ScateSDK.OnboardingStep('notification_screen');
ScateSDK.OnboardingStep('personalization_screen');
ScateSDK.OnboardingStep('journey_screen');
ScateSDK.OnboardingStep('intro_paywall_screen');
ScateSDK.OnboardingStep('fullscreen_ad');
ScateSDK.OnboardingFinish();

Login Event Functions

ScateSDK.LoginSuccess('apple');
ScateSDK.LoginSuccess('email');
ScateSDK.LoginSuccess('fb');
ScateSDK.LoginSuccess('google');

Ad Event Functions

ScateSDK.InterstitialAdShown();
ScateSDK.InterstitialAdClosed();
ScateSDK.RewardedAdShown();
ScateSDK.RewardedAdClosed();
ScateSDK.RewardedAdClaimed();
ScateSDK.BannerAdShown();

Permission Event Functions

ScateSDK.NotificationPermissionGranted();
ScateSDK.NotificationPermissionDenied();
ScateSDK.LocationPermissionGranted();
ScateSDK.LocationPermissionDenied();
ScateSDK.ATTPromptShown();
ScateSDK.ATTPermissionGranted();
ScateSDK.ATTPermissionDenied();

Paywall Event Functions

ScateSDK.PaywallShown('paywall_name');
ScateSDK.PaywallClosed('paywall_name');
ScateSDK.PaywallAttempted('paywall_name');
ScateSDK.PaywallPurchased('paywall_name');
ScateSDK.PaywallCancelled('paywall_name');

Tab And Feature Event Functions

ScateSDK.TabClicked('x');
ScateSDK.FeatureClicked('x');

Daily Streak Event Functions

ScateSDK.DailyStreakShown();
ScateSDK.DailyStreakClaimed();
ScateSDK.DailyStreakClosed();

Adjust And Revenuecat Event Functions

ScateSDK.RevenuecatInitiated();
ScateSDK.AdjustInitiated();
ScateSDK.AdjustSetToRevenuecat();

Splash Event Function

ScateSDK.SplashCompleted();

Firebase Event Function

ScateSDK.FirebaseRemoteInitiated();

Home Screen Event Function

ScateSDK.HomeScreenOpen();

Onboarding Paywall Event Functions

ScateSDK.OnboardingPaywallShown();
ScateSDK.OnboardingPaywallClosed();

Subscription & Purchase Event Functions

ScateSDK.SubscriptionSuccess();
ScateSDK.InAppPurchaseSuccess();
ScateSDK.SubsStart();
ScateSDK.SubsSuccess();
ScateSDK.SubsFail();
ScateSDK.SubsCancel();

Content Flow Event Functions

ScateSDK.ContentCreateStart();
ScateSDK.ContentCreateSuccess();
ScateSDK.ContentCreateFail();

Report to Scate that third-party services (Adjust, RevenueCat, Firebase, etc.) are ready in your app. This event does not initialize them.

ScateSDK.AllServicesInitialized();

Event List Screen Function (IOS Only)

ScateSDK.ShowEventList();

Onboarding And Paywall Screen Functions and Events

Show Paywall Screen

• Parameter: jsonString — A JSON string containing the screen paywall configuration.
• ⚠️ Note: You can find an example JSON object in the example/src/App.tsx file of the SDK repository.

ScateSDK.ShowPaywall('jsonString');

Close Paywall Screen

ScateSDK.ClosePaywall();

Show Onboarding Screen

• Parameter: jsonString — A JSON string containing the onboarding configuration.
• ⚠️ Note: You can find an example JSON object in the example/src/App.tsx file of the SDK repository.

ScateSDK.ShowOnboarding('jsonString');

Close Onboarding Screen

ScateSDK.CloseOnboarding();

Show Paid Product Loading Screen

ScateSDK.ShowPaidProductLoadingScreen();

Close Paid Product Loading Screen Clicked On A Product In Onboarding Or Paywall Screens)

ScateSDK.ClosePaidProductLoadingScreen();

Paywall And Onboarding Screen Events

ScateSDK.AddListener(
  ScateEvents.ONBOARDING_SCREENS_FINISHED,
  (identifier) => {}
);
ScateSDK.AddListener(ScateEvents.PAYWALL_SCREEN_FINISHED, (identifier) => {});
ScateSDK.AddListener(ScateEvents.PAID_PRODUCT_CLICKED, (identifier) => {});
ScateSDK.AddListener(ScateEvents.PAYWALL_SCREEN_CLOSED, (success) => {});
ScateSDK.AddListener(ScateEvents.ONBOARDING_SCREEN_CLOSED, (success) => {});
ScateSDK.AddListener(ScateEvents.RESTORE_PURCHASE_CLICKED, (success) => {});