Begin hier

Snelstart

Maak een API-sleutel, verifieer een domein en verstuur een gecontroleerde e-mail met een request dat veilig opnieuw geprobeerd kan worden.

Voordat je begint

Create a SendHQ workspace and keep the dashboard open. You can verify a domain and create an API key before paying. Sending requires an active subscription: there is no free allowance, including to your own address. Choose a plan at pricing.

1. Maak een API-sleutel aan

Open API keys in het dashboard, kies een beschrijvende naam zoals Production en kopieer de sleutel zodra die wordt getoond. Bewaar hem server-side in een secretmanager. SendHQ toont de volledige waarde daarna nooit meer.

.env
SENDHQ_API_KEY=re_your_key_here

2. Voeg een verzenddomein toe

Open Domains, add a domain you control, and publish the returned DKIM, SPF, DMARC, and domain verification records. Copy the records into your DNS host and click Verify. On Cloudflare, add them as DNS only (grey cloud). Add the records, then click Verify.

Do not publish a second SPF policy.If SPF already exists, merge SendHQ's SPF include (include:amazonses.com) into the existing v=spf1 value.

3. Wacht op de verificatie

Use the dashboard or POST /domains/:id/verify. DNS can move through pending, checking, and propagating before the sending identity is verified.

4. Verstuur een gecontroleerd bericht

curl
curl https://sendhq.cc/api/v1/emails \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: onboarding-user-42" \
  -d '{"from":"Acme <hello@example.com>","to":["owner@example.com"],"subject":"SendHQ is connected","html":"<h1>It works</h1><p>Your first controlled message was accepted.</p>","text":"It works. Your first controlled message was accepted."}'

Een geslaagd request geeft een SendHQ-e-mail-ID, het bericht-ID van de provider en het ID van de conversatiethread terug. Sla het SendHQ-ID op bij het applicatie-event dat de e-mail heeft veroorzaakt.

5. Verwerk de uitkomsten

Een geaccepteerd API-request is niet hetzelfde als aflevering bij de ontvanger. Haal /emails/:id/events op of gebruik het dashboard om bezorg-, bounce-, klacht-, reject-, open- en klikevents te bekijken.