Install Refiner with our NPM Package

Our official NPM wrapper class provides a simple installation of the Refiner.io client through NPM.

This NPM package automatically injects the Refiner.io JavaScript clients and exports an object that wraps all client methods. All method calls are queued end executed once the Refiner.io JavaScript client is fully loaded.

Once installed, Popup Surveys and Call To Actions created through the Refiner dashboard are launched automatically according to their trigger configuration.

Installation

npm install refiner.io;

Usage

Quick installation

Copy & paste the code below into your applications and replace the static value ‘REFINER_PROJECT_ID’. You can find your project ID in the your Refiner dashboard under “Settings > Installation”.

That’s it! The Refiner JavaScript is now loaded and communicating with the Refiner API.

import Refiner from 'refiner-js';

Refiner('setProject', 'REFINER_PROJECT_ID');

Identify your users (recommended)

Refiner unleashes its full power when you identify your users and we highly recommend that you take the time to set up user identification.

Identifying your users allows you to better target specific accounts, sync survey responses with your user data, trigger user specific automations etc.

Identifying a user is easy with our Javascript client. All you need to do is to call a identifyUser method once our Javasript client was loaded.

Refiner('identifyUser', {
  id: 'USER-ID-ABC-123', // Each user needs an ID or email address
  email: 'jane@awesome.com', // Each user needs an ID or email address
  name: 'Jane Doe', // The full name of the user
});

Please don’t hesitate to get in contact with our support team if you have any questions or need help installing Refiner.

Was this helpful?