Avis
Chaque avis est un POST JSON. L'en-tête usn-signature vaut sha256= suivi du HMAC du corps brut. Un exemple envoyé depuis le bureau porte l'identifiant 0. Le détail change selon l'application.
Lettres
Délivrance, report, ouverture, clic, désinscription et refus d'une lettre.
Délivré
Le serveur destinataire a accepté le message.
{
"id": "4821",
"type": "delivered",
"at": "2026-11-07T14:32:00Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {}
}Reporté
Le message attend un nouvel essai.
{
"id": "4831",
"type": "deferred",
"at": "2026-11-07T14:32:04Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {}
}Adresse morte
L'adresse n'existe pas, ou elle refuse durablement. Le détail porte le code et la raison.
{
"id": "4822",
"type": "hard_bounce",
"at": "2026-11-07T14:32:08Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {
"code": "550",
"reason": "user unknown"
}
}Refus
Le message a été refusé par une règle. Le détail porte le code et la raison.
{
"id": "4823",
"type": "policy_reject",
"at": "2026-11-07T14:32:11Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {
"code": "550",
"reason": "policy",
"class": "policy"
}
}Plainte
La personne a signalé le message comme indésirable.
{
"id": "4824",
"type": "complaint",
"at": "2026-11-07T14:40:00Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {}
}Ouverture
La personne a ouvert la lettre. Le détail porte l'appareil et le logiciel.
{
"id": "4825",
"type": "open",
"at": "2026-11-07T15:01:00Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {
"device": "phone",
"client": "gmail"
}
}Clic
La personne a suivi un lien. Le détail porte l'adresse.
{
"id": "4826",
"type": "click",
"at": "2026-11-07T15:02:00Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {
"link": "https://exemple.fr/samedi"
}
}Désinscription
La personne s'est désinscrite.
{
"id": "4827",
"type": "unsub",
"at": "2026-11-07T15:04:00Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {}
}Courrier en file
Un courrier a été mis en file depuis l'API.
{
"id": "4834",
"type": "letter_queued",
"at": "2026-11-07T16:20:00Z",
"email": "personne@exemple.fr",
"campaign": null,
"letter": "7f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"detail": {}
}Formulaires
Une réponse vient d'être enregistrée.
Formulaire
Un formulaire a reçu une réponse. Le détail porte le formulaire.
{
"id": "4828",
"type": "form_submit",
"at": "2026-11-07T15:10:00Z",
"email": "personne@exemple.fr",
"campaign": null,
"letter": null,
"detail": {
"form": "a1b2c3d4-e5f6-4789-a012-3456789abcde"
}
}Scénarios
Une personne entre dans un scénario, ou le scénario lui écrit.
Entrée dans un scénario
Une personne est entrée dans un scénario.
{
"id": "4829",
"type": "automation_entered",
"at": "2026-11-07T15:12:00Z",
"email": "personne@exemple.fr",
"campaign": null,
"letter": null,
"detail": {}
}Envoi de scénario
Un scénario a envoyé une lettre.
{
"id": "4830",
"type": "automation_sent",
"at": "2026-11-07T16:12:00Z",
"email": "personne@exemple.fr",
"campaign": "6f1c0a2e-4b7d-4e1a-9c3f-8a2b1d0e5f77",
"letter": null,
"detail": {}
}QR codes
Quelqu'un ouvre un QR code.
Scan
Le détail porte le QR, le lieu et l'appareil.
{
"id": "4832",
"type": "scan",
"at": "2026-11-07T15:20:00Z",
"email": "personne@exemple.fr",
"campaign": null,
"letter": null,
"detail": {
"qr": "b1b2c3d4-e5f6-4789-a012-3456789abcde",
"place": "Accueil",
"device": "phone"
}
}Pages
Quelqu'un ouvre une page publiée.
Page vue
Le détail porte la page ouverte.
{
"id": "4833",
"type": "page_view",
"at": "2026-11-07T15:22:00Z",
"email": "personne@exemple.fr",
"campaign": null,
"letter": null,
"detail": {
"page": "c1b2c3d4-e5f6-4789-a012-3456789abcde"
}
}