RudderStack Node.js SDK

Detailed technical documentation on using RudderStack’s Node.js SDK to send events to various destinations

RudderStack’s Node.js SDK allows you to track your customer event data from your Node.js code. Once enabled, the event requests hit the RudderStack servers. RudderStack then routes the events to the specified destination platforms as configured by you.

You can find this SDK in our GitHub repository.

Installing the RudderStack Node.js SDK

To install the RudderStack Node.js SDK using npm, run the following command:

npm install @rudderstack/rudder-sdk-node

Using the RudderStack Node.js SDK

To use the SDK, run the following code snippet:

const Analytics = require("@rudderstack/rudder-sdk-node");
// we need the batch endpoint of the Rudder server you are running
const client = new Analytics("WRITE_KEY", "DATA_PLANE_URL/v1/batch");

Identify

The identify call lets you associate a user to their actions as well as captures the relevant traits or properties related to that user.

For a detailed explanation of the identify call, please refer to our RudderStack API specification guide.

An example identify call is as shown:

Analytics.identify({
userId: '123456',
traits: {
name: 'Name Username',
email: 'name@website.com',
plan: 'Free',
friends: 21
}
});

The identify method parameters are as described below:

Field

Type

Presence

Description

anonymousId

String

Optional

Sets the user ID for cases where there is no unique identifier for the user. Either userId or anonymousId is required.

userId

String

Optional, if anonymousId is already set

Unique identifier for a particular user in your database.

context

Object

Optional

Dictionary of information that provides context about a message. However, it is not directly related to the API call.

integrations

Object

Optional

A dictionary containing the destinations to be either enabled or disabled.

timestamp

Date

Optional

The timestamp of the message's arrival.

traits

Object

Optional

Dictionary of the traits associated with the user, such as nameor email

Track

The track call lets you record the users' actions along with their associated properties. Each triggered action is called an 'event'.

For a detailed explanation of the track call, please refer to our RudderStack API specification guide.

An example track call is as shown:

Analytics.track({
userId: '123456',
event: 'Item Viewed',
properties: {
revenue: 19.95,
shippingMethod: 'Premium'
}
});

The track method parameters are as described below:

Name

Type

Presence

Description

user_id

String

Required

The developer identification for your user

event

String

Required

Name of the event being performed by the user

properties

Object

Optional

Dictionary of the properties associated with a particular event.

context

Object

Optional

Dictionary of information that provides context about a message. However, it is not directly related to the API call.

timestamp

Date

Optional

The timestamp of the message's arrival.

anonymous_id

String

Optional

Sets the user ID for cases where there is no unique identifier for the user. Either userId or anonymousId is required.

integrations

Object

Optional

A dictionary containing the destinations to be either enabled or disabled.

Page

The page call allows you to record the page views on your website. It also records the other relevant information about the page that is being viewed.

For a detailed explanation of the page call, please refer to our RudderStack API specification guide.

An example page call is as shown:

Analytics.page({
userId: '12345',
category: 'Food',
name: 'Pizza',
properties: {
url: 'https://dominos.com',
title: 'Pizza',
referrer: 'https://google.com'
}
});

The page method parameters are as described below:

Field

Type

Presence

Description

anonymousId

String

Optional

Sets the user ID for cases where there is no unique identifier for the user. Either userId or anonymousId is required.

userId

String

Optional, if anonymousId is already set

Unique identifier for a particular user in your database.

context

Object

Optional

Dictionary of information that provides context about a message. However, it is not directly related to the API call.

integrations

Object

Optional

A dictionary containing the destinations to be either enabled or disabled.

name

String

Required

Name of the page being viewed.

properties

Object

Optional

Dictionary of the properties associated with the page being viewed, such as url and referrer

timestamp

Date

Optional

The timestamp of the message's arrival.

Group

The identify call allows you to associate an identified user to a group - either a company, project, or a team. You can also record custom traits or properties associated with that group.

For a detailed explanation of the group call, please refer to our RudderStack API specification guide.

An example group call is as shown:

Analytics.group({
userId: '12345',
groupId: '1',
traits: {
name: 'Company',
description: 'Google'
}
});

The group method parameters are as follows:

Field

Type

Presence

Description

anonymousId

String

Optional

Sets the user ID for cases where there is no unique identifier for the user. Either userId or anonymousId is required.

userId

String

Optional, if anonymousId is already set

Unique identifier for a particular user in your database.

context

Object

Optional

Dictionary of information that provides context about a message. However, it is not directly related to the API call.

integrations

Object

Optional

A dictionary containing the destinations to be either enabled or disabled.

groupId

String

Required

Unique identifier of the group, as present in your database.

traits

Object

Optional

Dictionary of the properties or traits associated with the group, such as email or name.

timestamp

Date

Optional

The timestamp of the message's arrival.

Alias

The alias call allows you to associate one identity with another.

alias is an advanced method. However, it is required when managing user identities in some destinations.

An example alias call is as shown:

Analytics.alias({
previousId: 'old_id',
userId: 'new_id'
});

The alias method parameters are as mentioned below:

Field

Type

Presence

Description

userId

String

Optional, if anonymousId is already set

Unique identifier for a particular user in your database.

context

Object

Optional

Dictionary of information that provides context about a message. However, it is not directly related to the API call.

integrations

Object

Optional

A dictionary containing the destinations to be either enabled or disabled.

previousId

String

Required

The previous unique identifier of the user.

traits

Object

Optional

Dictionary of the properties or traits associated with the group, such as email or name.

timestamp

Date

Optional

The timestamp of the message's arrival.

For a detailed explanation of the alias call, please refer to our RudderStack API specification guide.

Contact Us

To know more about the RudderStack Node.js SDK, you can contact us or see the SDK in action. You can also talk to us on our Discord channel.

In case you come across any issues while using this SDK, please feel free to contact us.