SDK Initialization

Install the Twinalyze JavaScript Analytics SDK and initialize it once when your website or application starts.

Add the SDK dependency

Choose your preferred installation method.

npm install @twinalyze/web-analytics

<script src="https://cdn.jsdelivr.net/npm/@twinalyze/web-analytics/dist/cdn.global.min.js"></script>

Initialize the SDK

Add this Javascript sdk script to your code and your SDK is ready to send events.

import TwinalyzeAnalytics from "@twinalyze/web-analytics";

TwinalyzeAnalytics.init({
  apiKey: "YOUR_API_KEY",
  secretKey: "YOUR_SECRET_KEY",
});

<script>
  window.TwinalyzeAnalytics.init({
    apiKey: "YOUR_API_KEY",
    secretKey: "YOUR_SECRET_KEY",
  });
</script>

Replace YOUR_API_KEY and YOUR_SECRET_KEY with the credentials available in your Twinalyze project.

Initialize the SDK only once. After initialization, Twinalyze creates the device and session identifiers and starts collecting supported website events.

Enable Firebase Cloud Messaging

The complete configuration allows you to manage sessions, automatic event tracking, site search, file downloads, and Firebase Cloud Messaging.

import TwinalyzeAnalytics from "@twinalyze/web-analytics";

TwinalyzeAnalytics.init({
  apiKey: "YOUR_API_KEY",
  secretKey: "YOUR_SECRET_KEY",

  fcm: {
    enabled: true,
    configUrl: "/twinalyze-fcm-sw.js",
    serviceWorkerPath: "/twinalyze-fcm-sw.js",
  },
});

<script src="https://cdn.jsdelivr.net/npm/@twinalyze/web-analytics/dist/cdn.global.min.js"></script>

<script>
  window.TwinalyzeAnalytics.init({
    apiKey: "YOUR_API_KEY",
    secretKey: "YOUR_SECRET_KEY",

    fcm: {
      enabled: true,
      configUrl: "/twinalyze-fcm-sw.js",
      serviceWorkerPath: "/twinalyze-fcm-sw.js",
    },
  });
</script>

To enable web push notifications, create the following service worker file:

public/twinalyze-fcm-sw.js

The final file must be publicly available at:

https://your-domain.com/twinalyze-fcm-sw.js

To enable web push notifications, download the Twinalyze Firebase service worker file.

Twinalyze FCM Service Worker

Download the worker file and add your Firebase configuration.

twinalyze-fcm-sw.js

Place this file in your application’s public root directory.

Request notification permission

Notification permission must be requested after a user action, such as clicking an Enable Notifications button. Call the function from a button:

<button onclick="enableNotifications()">
  Enable Notifications
</button>

async function enableNotifications() {
  if (!("Notification" in window)) {
    console.log("Notifications are not supported.");
    return;
  }

  const permission =await Notification.requestPermission();

  if (permission === "granted") {
    console.log("Notification permission granted."
    );
  }

  if (permission === "denied") {
    console.log( "Notification permission denied."
    );
  }
}

FCM works only when the browser supports notifications, FCM is enabled, the service worker is publicly available, and notification permission is granted.

‹Previous Connect website activity with known users.Next›

​Add the SDK dependency

​Initialize the SDK

​Enable Firebase Cloud Messaging

​Request notification permission

Add the SDK dependency

Initialize the SDK

Enable Firebase Cloud Messaging

Request notification permission