Sign inGet Started

Je eerste e-mail versturen

Maak een API-sleutel aan, verstuur via het gedeelde onboardingdomein van Bird en controleer het resultaat. Voor deze handleiding hoef je geen verzenddomein te verifiëren en geen DNS-records te publiceren. Verifieer je eigen domein voordat je naar klanten verstuurt.

1. Maak een API-sleutel aan

Ga in het dashboard naar Platform tools > API keys en maak een sleutel aan. Sleutels zijn gebonden aan een regio en zien eruit als bk_us1_... of bk_eu1_.... De regio in het voorvoegsel bepaalt welke API-host je aanroept: https://us1.platform.bird.com of https://eu1.platform.bird.com.

De pagina API Keys in het Bird-dashboard, met sleutels, hun gemaskeerde voorvoegsel, scopes en het tijdstip van laatste gebruik

De volledige sleutel wordt één keer getoond, bij het aanmaken. Kopieer hem naar een veilige plek en exporteer hem daarna, zodat de codevoorbeelden in stap 2 hem kunnen lezen:

Codevoorbeeld
export BIRD_API_KEY="bk_us1_..."

2. Verstuur een e-mail

Verstuur vanaf onboarding@messagebird.dev, het gedeelde onboardingdomein van Bird, dat zonder configuratie beschikbaar is in je werkruimte. Adresseer de e-mail aan delivered@messagebird.dev, een sandbox-ontvanger die altijd bezorgt. Zo is het resultaat voorspelbaar zonder echte mailbox.

De cURL-aanroep gebruikt de Amerikaanse host. Begint je sleutel met bk_eu1_, roep dan https://eu1.platform.bird.com aan. De SDK leest de regio uit je sleutel en kiest de host. Het TypeScript-tabblad vereist npm install @messagebird/sdk.

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);

Volledige installatie- en uitvoeringsstappen per taal of framework vind je in de SDK-quickstarts.

3. Bekijk het resultaat

De API antwoordt met 202: Bird heeft de verzending geaccepteerd voor asynchrone verwerking. Controleer de bezorgstatus apart. De *_count-velden volgen ontvangers door de bezorgstatussen. In het eerste antwoord is één ontvanger geaccepteerd en is er nog geen bezorgd.

Codevoorbeeld
{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted",
  "category": "marketing",
  "from": { "email": "onboarding@messagebird.dev" },
  "to": [{ "email": "delivered@messagebird.dev" }],
  "subject": "Hello from Bird",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "deferred_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": true,
  "track_clicks": true,
  "created_at": "2026-07-23T13:58:20.866Z"
}

Haal het bericht op met de em_-ID om de huidige status te zien. Een bericht gaat van accepted via processed naar delivered. Vraag de status herhaaldelijk op totdat het sandboxbericht delivered bereikt:

const msg = await bird.email.get("em_abc123");
msg.status; // "accepted" | "processed" | "delivered" | "bounced" | …
msg.delivered_count;
msg.bounced_count;
console.log(msg.subject, msg.subject_recipient_id);

Vervang op het tabblad cURL {region} en {message_id}, en gebruik $BIRD_API_KEY in plaats van $TOKEN.

Het opgehaalde bericht toont nu status: "delivered", delivered_count: 1 en een tijdstempel delivered_at. In de handleiding over events lees je wat delivered betekent voor een echte ontvanger.

Omdat je naar delivered@messagebird.dev hebt verzonden, staat de uitkomst vast: het bericht doorloopt de echte bezorgpipeline van Bird, inclusief de vorm van productie-events en webhooks, maar komt nooit in een echte mailbox terecht. Verzend naar bounce@messagebird.dev om een bounce te testen. De handleiding over de testsandbox vermeldt elk sandboxadres en de gesimuleerde uitkomst ervan.

Over het onboardingdomein

De gedeelde afzender onboarding@messagebird.dev is beschikbaar voor onboarding en heeft deze beperkingen:

  • Behalve naar de sandboxadressen van @messagebird.dev bezorgt deze alleen bij geverifieerde leden van je werkruimte; elke andere ontvanger wordt geweigerd met een 422.
  • Verzendingen zijn beperkt tot 50 ontvangers per organisatie per UTC-dag. Daarbij telt elk adres in to, cc en bcc mee, ook sandboxontvangers. Boven die limiet retourneert de API een 429.

Wil je e-mail sturen naar echte klanten, verifieer dan je eigen verzenddomein en zet je eigen adres in from; de rest van het verzoek blijft hetzelfde.

Volgende stappen

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.