JavaScript SDK

Official Userpilot JavaScript SDK methods and usage.

The Userpilot JavaScript SDK allows you to identify users, track events, trigger content, and manage sessions directly from your web application.

---

Installation

npm install @userpilot/sdk

Or include via CDN:

<script src="https://js.userpilot.io/sdk.js"></script>

---

Getting Started

To use the SDK, ensure it is loaded on your page. Then, you can call the available methods on the userpilot object.

---

Methods

identify(userId, [properties])

Identifies the current user with an ID and optional properties.

userpilot.identify("123", {
  name: "John",
  email: "[e-mail]",
  created_at: "1519205055"
  // Additional user properties
});

---

anonymous()

Assigns a session-based unique ID for the current user on public pages.

userpilot.anonymous();

---

reload([options])

Updates Userpilot content when the page state changes.

userpilot.reload();
userpilot.reload({ url: 'https://example.com/hello' });

---

track(name, [properties])

Tracks a custom event for the current user.

userpilot.track("invitedAgent", {
  name: "Sam",
  email: "[e-mail]"
});

---

trigger(contentId)

Forces a specific Userpilot content to show for the current user.

userpilot.trigger(17);

---

on(event, callback)

Registers a callback for a Userpilot event.

userpilot.on('completed', function(event) {
  alert('Flow completed');
});

Event Examples

// Flow started
userpilot.on('started', (event) => { /* ... */ });

// Flow completed
userpilot.on('completed', (event) => { /* ... */ });

// Flow dismissed
userpilot.on('dismissed', (event) => { /* ... */ });

// Step interaction
userpilot.on('step', (event) => { /* ... */ });

---

off(event)

Removes a callback function attached to an event.

---

once(event, callback)

Registers a callback to be triggered only once.

---

userpilot.end()

Ends the currently running flow.

---

userpilot.clean()

Clears Userpilot storage and session data.

---

userpilot.destroy()

Fully clears Userpilot storage and removes all active content.

---

Parameters

Method	Parameters	Description
identify	userId, properties?	Identify a user and set properties
anonymous		Assign a session-based ID
reload	options?	Reload Userpilot content
track	name, properties?	Track a custom event
trigger	contentId	Show specific content
on	event, callback	Listen for Userpilot events
off	event	Remove event listener
once	event, callback	Listen for event once
end		End the current flow
clean		Clear Userpilot storage
destroy		Remove all Userpilot data and content

---

For any questions or concerns, please reach out to [e-mail]