DeckleDocs
Dashboard

Get started

Quickstart

Create an API key and send your first email in a few minutes — with the SDK, plain HTTP, or SMTP.

This guide gets a single email out the door. In test mode you can start immediately; to reach real inboxes you’ll verify a sending domain at the end.

Create an API key

In the dashboard, open Developers → API keys and create a key. Pick the Test environment to experiment safely. Copy the key — it starts with sk_test_ and is shown only once.

Store it safely

Deckle stores only a hash of your key. If you lose it, revoke the key and create a new one. Never commit keys — load them from an environment variable.

Install the SDK (optional)

The official Node.js SDK is zero-dependency and works on Node 18+, Deno, Bun, and the browser. Prefer raw HTTP? Skip ahead to the next step.

bash
npm install @deckle/sdk

Send an email

Set your key as an environment variable, then send:

import { Deckle } from "@deckle/sdk";

const deckle = new Deckle(process.env.DECKLE_API_KEY!);

const { id } = await deckle.emails.send({
  from: "Acme <onboarding@acme.com>",
  to: "delivered@resend-like.simulator", // use success@simulator.amazonses.com in test mode
  subject: "Hello from Deckle",
  html: "<h1>It works!</h1><p>Your first Deckle email.</p>",
});

console.log("Queued:", id);

Test mode

A sk_test_ key can only send to the AWS SES simulator (for example success@simulator.amazonses.com) or to your own verified domains — never a real inbox. That makes it safe to run in CI.

Verify a domain to go live

To send to real recipients, add and verify a sending domain, then switch to a sk_live_ key. Deckle generates the DKIM, SPF, and DMARC records for you to publish at your DNS provider.

  • Open Domains and add your domain.
  • Publish the DKIM, SPF & DMARC records.
  • Wait for verification (auto-polled), then send from an address on that domain.

What’s next#

You’ve sent an email. Here’s where to go from here.