NPM

Prerequisites

Before you get started, you need to:

• Create a honeypot
• Install Node.js v16 or above

Installation

Use your preferred package manager to install Honeypot:

npm

$ npm add @honeypot-run/core

pnpm

$ pnpm add @honeypot-run/core

yarn

$ yarn add @honeypot-run/core

Importing

The next step is to import and initialize the Collector.

You will need to pass in the URL for your honeypot, which can be found on the

Honeypots page.

import { honeypot } from '@honeypot-run/core';

const url = 'https://<my-honeypot-url>/js'
honeypot.setup({ url })

Once you've initialized Honeypot using the code above, you're ready to track events.

Typescript support

We recommend utilizing TypeScript for improved developer experience and prevention of common errors.

The type definitions for the Honeypot SDKs are included with the library. For more information, review our TypeDocs documentation.