@causalfoundry/js-sdk v0.9.6

Causal Foundry JS SDK

For detailed documentation please visit: docs.causalfoundry.ai

Guidelines

• Anything you include in the meta will be sent to the backend and be visible in the log monitoring section, but it will not be processed.

• Custom Event Attributes can be of these data types: String, Number, Boolean, Date, List, Map.

• Make sure to include your SDK key while initialization or else it would through an exception.

• By default, SDK logs the events after evert 10 seconds. You can decide for each event if it needs to be updated immediately, or it can wait until the end of the app session. To send an event immediately, you can use: ECommerce.logItemEvent(props, sendNow) // set sendNow to true to log immediately

• Please ensure consistent usage of the names of Custom Events in meta and their Custom Attributes across all your apps (Android, iOS, Web) and website.

• Please use the same name conventions as provided by the enums if you choose to pass strings as values or else an erorr will be thrown.

• Nudges may not be delivered to apps which were put into background restriction by the user (such as via: Setting -> Apps and Notification -> app-name -> Battery). Once your app is removed from background restriction, new messages to the app will be delivered as before. In order to prevent lost messages and other background restriction impacts, make sure to avoid bad behaviors listed by the Android vitals effort. These behaviors could lead to the Android device recommending to the user that your app be background restricted. Your app can check if it is background restricted using: isBackgroundRestricted().

• In situations where your web app is used inside a webview in android, do update the DOM-Storage of the webview to allow local storage. To do that you can use: webView.settings.domStorageEnabled = true

• In cases where the user restricted the app to show push notifications for the whole app or blocked the causalfoundry notification channel, the SDK will log block event for that nudge.

Please feel free to drop in a few lines at support@causalfoundry.ai in case you have any further queries. We're always just an email away!