Node.js

Send your first message from a Node.js project with the official Postwick library.

Add the Postwick Node.js SDK to this project, read POSTWICK_API_KEY from the environment and send a test email to delivered@postwick.dev.

Prerequisites

Before you begin you need:

• A Postwick API key

• A verified sending domain

Guide

1. Install

   Add the library to your project.

   • npm
   • yarn
   • pnpm
   • bun

   npm install postwick

2. Store your API key

   Keep the key out of source control by putting it in an environment variable.

   POSTWICK_API_KEY=pw_live_4f9c2e7a1b

3. Send an email

   The smallest useful call takes a sender, a recipient, a subject and a body.

   import { Postwick } from 'postwick';
   
   const postwick = new Postwick(process.env.POSTWICK_API_KEY);
   
   const { data, error } = await postwick.emails.send({
     from: 'Lumen <hello@mail.lumen.dev>',
     to: ['ada@example.com'],
     subject: 'Your receipt from Lumen',
     html: '<p>Thanks for your order, Ada.</p>',
   });
   
   if (error) {
     console.error(error);
   }

Examples