С чего начать

Быстрый старт

Создайте ключ, подтвердите домен и отправьте контрольное письмо запросом, который безопасно повторять.

Перед началом

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. Создайте API-ключ

Откройте в панели управления раздел API keys, выберите понятное имя, например Production, и скопируйте ключ, когда он будет показан. Храните его в серверном хранилище секретов. SendHQ больше никогда не покажет полное значение.

.env
SENDHQ_API_KEY=re_your_key_here

2. Добавьте домен отправки

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. Дождитесь подтверждения

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

4. Отправьте контрольное письмо

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

Успешный запрос возвращает ID письма в SendHQ, ID сообщения у провайдера и ID цепочки переписки. Сохраните ID SendHQ вместе с событием приложения, которое вызвало отправку письма.

5. Обработайте результаты

Принятый API-запрос — ещё не доставка получателю. Запросите /emails/:id/events или откройте панель управления, чтобы посмотреть события доставки, отказа, жалобы, отклонения, открытия и клика.