@plunk/node

Plunk Node.js

This project contains the helper library for interacting with the Plunk API using Node.js.

Table of contents

• Installation
• Getting started
• API
  • Events

Installation

Installing the latest version can be done through your package manager.

npm i @plunk/node

yarn add @plunk/node

Getting started

Any interaction you want to make with the Plunk API needs to be done through the Plunk client. You can use a default import to get started.

import Plunk from '@plunk/node';

const plunk = new Plunk("Your secret key");

API

Events

publish()

Used to publish an event

Parameters

• event: The name of the event to publish
• email: The email address of the user to publish the event to
• data [Optional]: An object containing the data to attach to the user

const success = await plunk.events.publish({
  event: "new-project",
  email: "[e-mail]",
  data: {
    company: "Plunk"
  }
});