Webhooky

Podepsané POST na vaši URL při otevření, prokliku, bounce, stížnosti nebo odhlášení. Webhook založíte přes POST /api/v1/webhooks.

Výchozí formát: jedna událost v jednom požadavku

Každá událost přijde jako samostatný POST s tímto tělem. Platí pro všechny webhooky, které dávkový formát nezapnuly.

{
  "event": "click",
  "email": "customer@example.com",
  "campaignUuid": "019ed1ac-30a6-75be-9204-5a66a318922e",
  "timestamp": "2026-10-14T10:34:49+02:00"
}

Dávkový formát (volitelný)

Jeden POST nese pole až 100 událostí v klíči events. Každá položka má stejná pole jako výchozí formát. Hlavička X-SmartMailer-Event má hodnotu batch.

{
  "events": [
    {
      "event": "open",
      "email": "customer@example.com",
      "campaignUuid": "019ed1ac-30a6-75be-9204-5a66a318922e",
      "timestamp": "2026-10-14T10:34:49+02:00"
    },
    {
      "event": "click",
      "email": "other@example.com",
      "campaignUuid": "019ed1ac-30a6-75be-9204-5a66a318922e",
      "timestamp": "2026-10-14T10:34:50+02:00"
    }
  ]
}

Dávkový formát zapnete při založení webhooku polem "batch": true. Bez něj webhook dostává výchozí formát. Stav vrací GET /api/v1/webhooks v poli batch.

POST /api/v1/webhooks
{
  "url": "https://example.com/smartmailer-webhook",
  "events": ["open", "click", "unsubscribed"],
  "batch": true
}

Hlavičky a podpis

  • X-SmartMailer-Event: typ události (open, click, bounce, hardBounce, complaint, unsubscribed), u dávky batch.
  • X-SmartMailer-Signature: HMAC-SHA256 těla požadavku v hex, klíčem je secret, který vrátilo založení webhooku.
  • Podpis ověřujte nad syrovým tělem požadavku a porovnávejte v konstantním čase (hash_equals, timingSafeEqual).

Doručení a výpadky endpointu

  • Na odpověď čekáme nejvýš 5 sekund. Odpovídejte rychle stavem 2xx a těžší zpracování si dejte do vlastní fronty.
  • Po 5 neúspěšných doručeních za sebou (stav 4xx nebo 5xx, chyba spojení, vypršený čas) webhook na 15 minut pozastavíme a události z té doby se nedoručí. Dokdy pauza trvá, ukazuje pole suspendedUntil v GET /api/v1/webhooks. Po pauze zkusíme doručit znovu.
  • Neúspěšné doručení neopakujeme. Každou událost pošleme nejvýš jednou.
  • Výjimečně může stejná událost přijít dvakrát. Deduplikujte podle event, email a campaignUuid.

Integrace

Seznam oficiálních integrací.

Název Odkaz
Modul pro PrestaShop Přenáší kontakty z objednávek a odběratele newsletteru a měří objednávky z kampaní. Zdarma, pro PrestaShop 1.6, 1.7, 8.x a 9.x. Stáhnout
Plugin pro WordPress a WooCommerce Posílá nové uživatele, zákazníky z objednávek WooCommerce a odeslané formuláře. Zdarma, pro WordPress 6.2+. Stáhnout
Plugin pro OpenCart Úplné propojení SmartMaileru s OpenCartem. Snadné použití. Pro OpenCart 3.x a 4.x. Stáhnout
Plugin pro Joomla Úplné propojení SmartMaileru s Joomlou včetně VirtueMartu. Snadné použití. Pro Joomla 5.4+. Stáhnout
E-shop Forga Propojení se SmartMailerem je součástí pronájmu e-shopu Forga. Nic se neinstaluje. Web
Shoptet Přímé propojení zatím není. Kontakty přenesete exportem do CSV a importem s přiřazením sloupců. Návod
Přechod ze SmartEmailingu Návod, jak kontakty a odhlášky ze SmartEmailingu vyexportovat do CSV a naimportovat do SmartMaileru. Návod
Přechod z Ecomailu Návod, jak kontakty a odhlášky z Ecomailu vyexportovat do CSV a naimportovat do SmartMaileru. Návod
Přechod z Mailchimpu Návod, jak kontakty a odhlášky z Mailchimpu vyexportovat do CSV a naimportovat do SmartMaileru. Návod
Ukázkový kód v PHP Jednoduchá ukázka napojení na API v PHP. Stáhnout

Domény odesílatele a DNS

Jak vložit záznamy z detailu domény u správce domény.

Po přidání domény odesílatele dostanete ve SmartMaileru záznamy TXT, CNAME a MX. Návod ukazuje, kam je vložit u WEDOS, Forpsi, Active24, Websupport, Cloudflare a dalších správců.

Otevřít návod