@nextengage/sdk

@nextengage/sdk

Official TypeScript SDK for the NextEngage marketing platform.

Install

pnpm add @nextengage/sdk

Usage

import { NextEngage } from "@nextengage/sdk";

const ne = new NextEngage({
  apiKey: process.env.NEXTENGAGE_API_KEY!, // ne_...
  baseUrl: "https://api.nextengage.io",        // API origin; defaults to localhost:3001
});

// Upsert a contact (by email)
await ne.contacts.upsert({
  email: "[e-mail]",
  attributes: { country: "IN", plan: "pro" },
});

// Track a behavioral event (feeds dynamic segments)
await ne.contacts.track({ email: "[e-mail]", name: "purchased", properties: { amount: 49 } });

// Bulk import
await ne.contacts.bulkImport([
  { email: "[e-mail]" },
  { email: "[e-mail]", attributes: { vip: true } },
]);

// Create + send a campaign
const tpl = await ne.templates.create({ name: "Promo", subject: "Hi {{ email }}", body: "<p>Sale!</p>" });
const campaign = await ne.campaigns.create({ name: "Spring", templateId: tpl.id, fromEmail: "[e-mail]" });
await ne.campaigns.send(campaign.id);

The API key is scoped to a single project; the SDK resolves the project id automatically from /me.

Error handling

Failed requests throw NextEngageError with status and parsed body.