Quick Start Guide

This guide walks you through the essential steps to start sending emails with Sequenzy.

Prerequisites

A Sequenzy account (sign up here)
A verified sending domain (configured in Settings → Domains)
An API key (generated in Settings → API Keys)

Step 1: Get Your API Key

Log in to your Sequenzy dashboard
Navigate to Workspace Settings → API Keys
Click Create API Key
Copy and securely store your key—it won’t be shown again

Keep your API key secret. Never expose it in client-side code or public repositories.

Managing multiple workspaces? Create an account key in Account Settings → API Keys and pass x-company-id: company_abc123 on each request. One seq_user_ key can target every workspace your account can access, including workspaces you create later.

Step 2: Install the SDK

Install the official Sequenzy SDK for Node.js/TypeScript:

npm install sequenzy

pnpm add sequenzy

bun add sequenzy

Then initialize the client:

import Sequenzy from "sequenzy";

const client = new Sequenzy({
  apiKey: process.env.SEQUENZY_API_KEY,
});

Step 3: Add Your First Subscriber

await client.subscribers.create({
  email: "john@example.com",
  firstName: "John",
  lastName: "Doe",
  tags: ["new-signup"],
  customAttributes: {
    plan: "free",
    source: "website",
  },
  enrollInSequences: true,
});

curl -X POST "https://api.sequenzy.com/api/v1/subscribers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "tags": ["new-signup"],
    "customAttributes": {
      "plan": "free",
      "source": "website"
    },
    "enrollInSequences": true
  }'

Step 4: Tag Subscribers Based on Actions

When users take actions in your app, tag them to trigger automations:

await client.subscribers.tags.add({
  email: "john@example.com",
  tag: "customer",
});

curl -X POST "https://api.sequenzy.com/api/v1/subscribers/tags" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john@example.com",
    "tag": "customer"
  }'

Step 5: Track Events

Send events when important things happen:

await client.subscribers.events.trigger({
  email: "john@example.com",
  event: "purchase_completed",
  properties: {
    orderId: "order_12345",
    amount: 99.99,
    product: "Pro Plan",
  },
});

curl -X POST "https://api.sequenzy.com/api/v1/subscribers/events" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john@example.com",
    "event": "purchase_completed",
    "properties": {
      "orderId": "order_12345",
      "amount": 99.99,
      "product": "Pro Plan"
    }
  }'

Step 6: Send a Transactional Email

Send an immediate email using a template or direct content:

Using a Template

await client.transactional.send({
  to: "john@example.com",
  slug: "welcome-email",
  variables: {
    firstName: "John",
    dashboardUrl: "https://app.example.com/dashboard",
  },
});

curl -X POST "https://api.sequenzy.com/api/v1/transactional/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "john@example.com",
    "slug": "welcome-email",
    "variables": {
      "firstName": "John",
      "dashboardUrl": "https://app.example.com/dashboard"
    }
  }'

Direct Content

await client.transactional.send({
  to: "john@example.com",
  subject: "Welcome to Our Platform!",
  body: "<h1>Welcome, {{firstName}}!</h1><p>Thanks for signing up.</p>",
  variables: {
    firstName: "John",
  },
});

curl -X POST "https://api.sequenzy.com/api/v1/transactional/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "john@example.com",
    "subject": "Welcome to Our Platform!",
    "body": "<h1>Welcome, {{FIRST_NAME}}!</h1><p>Thanks for signing up.</p>",
    "variables": {
      "firstName": "John"
    }
  }'

What’s Next?

Create a Sequence

Build automated email workflows

Send a Campaign

Broadcast to your subscribers

Set Up Sync Rules

Automate tagging based on events

Explore the API

Full API documentation

Common Integration Patterns

User Registration

import Sequenzy from "sequenzy";

const client = new Sequenzy({ apiKey: process.env.SEQUENZY_API_KEY });

// When a user signs up
await client.subscribers.create({
  email: user.email,
  firstName: user.firstName,
  lastName: user.lastName,
  tags: ["new-signup"],
  customAttributes: {
    userId: user.id,
    plan: "free",
    signupDate: new Date().toISOString(),
  },
  enrollInSequences: true,
});

Subscription Upgrade

// When a user upgrades
await client.subscribers.events.trigger({
  email: user.email,
  event: "saas.purchase",
  properties: {
    plan: "pro",
    amount: 29.99,
    currency: "USD",
  },
});

Order Confirmation

// Send order confirmation email
await client.transactional.send({
  to: customer.email,
  slug: "order-confirmation",
  variables: {
    orderNumber: order.id,
    total: order.total,
    items: order.items.map((i) => i.name).join(", "),
  },
});

Get Started

Send Email

Core Concepts

Email Features

SMS

Analytics

Deliverability

Guides

Widgets

Payment Integrations

Commerce Integrations

Website Integrations

Auth Integrations

Analytics Integrations

Ad Integrations

Affiliate Integrations

Automation Integrations

Developer Tools

Quick Start

Quick Start Guide

Prerequisites

Step 1: Get Your API Key

Step 2: Install the SDK

Step 3: Add Your First Subscriber

Step 4: Tag Subscribers Based on Actions

Step 5: Track Events

Step 6: Send a Transactional Email

Using a Template

Direct Content

What’s Next?

Create a Sequence

Send a Campaign

Set Up Sync Rules

Explore the API

Common Integration Patterns

User Registration

Subscription Upgrade

Order Confirmation

​Quick Start Guide

​Prerequisites

​Step 1: Get Your API Key

​Step 2: Install the SDK

​Step 3: Add Your First Subscriber

​Step 4: Tag Subscribers Based on Actions

​Step 5: Track Events

​Step 6: Send a Transactional Email

​Using a Template

​Direct Content

​What’s Next?

Create a Sequence

Send a Campaign

Set Up Sync Rules

Explore the API

​Common Integration Patterns

​User Registration

​Subscription Upgrade

​Order Confirmation

Quick Start Guide

Prerequisites

Step 1: Get Your API Key

Step 2: Install the SDK

Step 3: Add Your First Subscriber

Step 4: Tag Subscribers Based on Actions

Step 5: Track Events

Step 6: Send a Transactional Email

Using a Template

Direct Content

What’s Next?

Common Integration Patterns

User Registration

Subscription Upgrade

Order Confirmation