Pour commencer

Démarrage rapide

Créez une clé, vérifiez un domaine et envoyez un e-mail contrôlé avec une requête que l’on peut réessayer sans risque.

Avant de commencer

Create a SendHQ workspace and keep the dashboard open. New workspaces receive a controlled integration trial: deliveries can go only to the account email or a mailbox-simulator test address until a paid subscription is active.

1. Créer une clé API

Ouvrez Clés API dans le tableau de bord, choisissez un nom explicite comme Production, puis copiez la clé lorsqu’elle s’affiche. Stockez-la dans un gestionnaire de secrets côté serveur. SendHQ ne renvoie plus jamais la valeur complète.

.env
SENDHQ_API_KEY=re_your_key_here

2. Ajouter un domaine d’envoi

Open Domains, add a domain you control, and publish the returned DKIM, SPF, DMARC, and domain verification records. Cloudflare users can authorize a one-time DNS setup; SendHQ discards the OAuth token after the callback.

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. Attendre la vérification

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

4. Envoyer un message contrôlé

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

Une requête réussie renvoie un identifiant d’e-mail SendHQ, l’identifiant de message du fournisseur et l’identifiant du fil de discussion. Enregistrez l’identifiant SendHQ avec l’événement applicatif qui a déclenché l’e-mail.

5. Traiter les résultats

Une requête API acceptée ne signifie pas que l’e-mail a été délivré au destinataire. Récupérez /emails/:id/events ou utilisez le tableau de bord pour consulter les événements de livraison, de bounce, de plainte, de rejet, d’ouverture et de clic.