Quick Start

This guide takes you from a new account to your first API-sent email. You need a Sequenzy account (sign up here).

You can send right away from the built-in sequenzymail.com domain. Its reputation is shared, so verify your own domain in Settings → Domain before you send to real customers.

Step 1: Get Your API Key

Sequenzy API key dialog with callouts showing purpose, preset, and permissions

Log in to your Sequenzy dashboard
Open Settings → API Keys & SMTP
Click Create API Key, name the key, and keep the Full access preset for this guide (a Transactional only key cannot run Steps 3-5)
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. Send money amounts in cents, so revenue goals and reports read them correctly:

await client.subscribers.events.trigger({
  email: "john@example.com",
  event: "purchase_completed",
  properties: {
    orderId: "order_12345",
    amount: 9999, // in cents
    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": 9999,
      "product": "Pro Plan"
    }
  }'

Step 6: Send a Transactional Email

Send an email right away with inline content, or with a template you design in the dashboard. The response includes an emailSendId you can look up in Sent Emails or with Get Email Send.

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, {{firstName}}!</h1><p>Thanks for signing up.</p>",
    "variables": {
      "firstName": "John"
    }
  }'

Using a Template

Create a template in Transactional in the dashboard and copy its slug, then send it by slug:

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"
    }
  }'

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

Get Started

AI Agents

Connect Your App

Send Transactional Email

Audience

Automations and Campaigns

Email Design

Forms and Landing Pages

Analytics

Deliverability

SMS, Push and In-app

Integrations

Ecommerce

Workspace and Billing

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

Direct Content

Using a Template

What’s Next?

Create a Sequence

Send a Campaign

Set Up Sync Rules

Explore the API

​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

​Direct Content

​Using a Template

​What’s Next?

Create a Sequence

Send a Campaign

Set Up Sync Rules

Explore the API

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

Direct Content

Using a Template

What’s Next?