This project contains the helper library for interacting with the Plunk API using Node.js.
Installing the latest version can be done through your package manager.
npm i @plunk/node
yarn add @plunk/node
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");
Used to publish an event
-
event
: The name of the event to publish -
email
: The email address of the user to publish the event to -
subscribed
[Optional]: Whether to the contact is subscribed to marketing emails, defaults totrue
-
data
[Optional]: An object containing the data to attach to the user
const success = await plunk.events.track({
event: "new-project",
email: "hello@useplunk.com",
data: {
company: "Plunk"
}
});
Used to send a transactional email
-
to
: The email address of the recipient -
subject
: The subject of the email -
body
: The body of the email -
type
[Optional]: The type of email to send (html
ormarkdown
) -
from
[Optional]: The email address of the sender -
name
[Optional]: The name of the sender -
subscribed
[Optional]: Whether to the contact is subscribed to marketing emails, defaults tofalse
const success = await plunk.emails.send({
to: "hello@useplunk.com",
subject: "Welcome to Plunk",
body: "Hello world!",
});