Node.js SDK

The Node.js SDK makes it easy to track events from Node.js applications.

Installation

The Node.js SDK is available via NPM.

To install the Node.js SDK, run:

npm install @ht-sdks/events-sdk-node

Then, initialize the SDK wherever you want to track events:

const Analytics = require('@ht-sdks/events-sdk-node');

const client = new Analytics("HT_WRITE_KEY", {
  dataPlaneUrl: "https://us-east-1.hightouch-events.com",
});

The Analytics constructor accepts the following parameters:

API

Identify

The identify method sends an identify event.

Unlike the Browser SDK, it does not persist the user ID and traits locally, so user IDs must be explicitly added to other events. This is because server side events are usually servicing many different users at once.

Example usage:

client.identify({
  userId: "123",
  traits: {
    location: "San Francisco",
  }
})

The first argument to the method is an object representing the identify event to be sent. The second argument is an optional callback that's invoked after the event is sent.

client.identify(message, [callback])

The message object may include the following fields:

Track

The track method sends a track event.

Example usage:

client.track({
  userId: "123",
  event: "Order completed",
  properties: {
    total: 29.99,
  }
})

The first argument to the method is an object representing the track event to be sent. The second argument is an optional callback that's invoked after the event is sent.

client.track(message, [callback])

The message object may include the following fields:

Page

The page method sends a page event.

Example usage:

client.page({
  userId: "123",
  category: "Docs",
  name: "Getting started",
})

The first argument to the method is an object representing the page event to be sent. The second argument is an optional callback that's invoked after the event is sent.

client.page(message, [callback])

The message object may include the following fields:

Screen

The screen method sends a screen event.

Example usage:

client.screen({
  userId: "123",
  category: "Docs",
  name: "Getting started",
})

The first argument to the method is an object representing the screen event to be sent. The second argument is an optional callback that's invoked after the event is sent.

client.screen(message, [callback])

The message object may include the following fields:

Group

The group method sends a group event.

Example usage:

client.group({
  userId: "123",
  groupId: "456",
  traits: {
    company_location: "San Francisco",
  },
})

The first argument to the method is an object representing the group event to be sent. The second argument is an optional callback that's invoked after the event is sent.

client.group(message, [callback])

The message object may include the following fields: