Documentation
Sign inGet started

TypeScript / Node.js

Send an email from a plain Node.js script with @messagebird/sdk. You'll need a Bird API key — create one in Developers → API keys as covered in Send your first email, then export it as BIRD_API_KEY.

1. Install

Code example
npm install @messagebird/sdk
# pnpm add @messagebird/sdk
# yarn add @messagebird/sdk
# bun add @messagebird/sdk
The SDK requires Node.js 20.3+ and is ESM-only.

2. Send

Create send.ts:
Code example
import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

const msg = await bird.email.send({
  from: { email: "onboarding@messagebird.dev", name: "Bird" },
  to: ["delivered@messagebird.dev"],
  subject: "Hello from Bird",
  html: "<p>My first Bird email.</p>",
});

console.log(msg.id, msg.status);
onboarding@messagebird.dev is Bird's shared onboarding sender and delivered@messagebird.dev is a sandbox recipient that always delivers — no domain verification needed. The region is inferred from your key's bk_us1_ / bk_eu1_ prefix, so there's no base URL to configure. The SDK auto-generates an Idempotency-Key per call, so retried sends are safe.

3. Run it

Code example
npx tsx send.ts
The API responds with 202 — Bird has accepted the message and delivers it asynchronously:
Code example
{
  "id": "em_019c1930687b7bfa8a1b2c3d4e5f6789",
  "status": "accepted"
}

Next steps