Getting Started

Learn how to start using Plaudy in minutes.

Sign up

Head over to app.plaudy.com/signup to create an account and get your api key. That's it! 🔥

Install

Install plaudy using yarn or npm:

// Using npm
npm install plaudy
// or yarn
yarn add plaudy

Import

One installed, use a simple require or import statement:

import Plaudy from 'plaudy';

Initialize

Init your workspace with .init(), where `YOUR API KEY` is replaced with the API Key in your dashboard.

Plaudy.init(`YOUR_API_KEY`);

Make sure to replace YOUR_API_KEY with your actual key or Plaudy will not track any events for you.

Identify (optional)

Identify the user and/or object that will be tracked for subsequent events. This benefits you by allowing you to skip passing these fields in for every single event tracked. However, you can always pass these fields through when calling .track() . USER_ID is your customer that you want to track this event for. OBJECT_ID is a secondary identifier for when the user has multiple spaces/workspaces/locations within a single account:

Plaudy.identify(`USER_ID`, `OBJECT_ID`);

It is possible to track events without identifying the user. In this case, the tracked user recorded for the event will be no_tracked_user. This allows you to still have query-friendly events for things like overall app usage, button clicks on your landing page, etc. We've done this on our landing page as an example.

Now you know how to get it set up. It's time to start tracking events! 🙌