Emailit
Dokumentace Webhooky Události

email.accepted

Spuštěno, když je e-mail přijat k doručení.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.accepted",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "odesilatel@example.com",
      "to": "prijemce@example.com",
      "subject": "Vítejte v Emailit",
      "meta": { "campaign": "uvitaci-serie" },
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

meta object | null

Vlastní metadata připojená k e-mailu.

created_at string

Časové razítko ve formátu ISO 8601 udávající, kdy byl e-mail vytvořen.

email.scheduled

Spuštěno při naplánování e-mailu k budoucímu doručení.

{
  "event_id": "2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.scheduled",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Weekly Digest",
      "meta": { "series": "weekly" },
      "scheduled_at": "2026-02-15T09:00:00.000000+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

meta object | null

Vlastní metadata připojená k e-mailu.

scheduled_at string

Časové razítko ve formátu ISO 8601 pro naplánované doručení.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.delivered

Spouští se, když je e-mail úspěšně doručen na poštovní server příjemce.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.delivered",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "delivered",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

status string

Vždy delivered.

meta object | null

Vlastní metadata připojená k e-mailu.

updated_at string

Časové razítko ve formátu ISO 8601 označující změnu stavu.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.bounced

Spouští se, když se e-mail trvale nepodaří doručit (tvrdý bounce).

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.bounced",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "bounced",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

status string

Vždy bounced.

meta object | null

Vlastní metadata připojená k e-mailu.

updated_at string

Časové razítko ve formátu ISO 8601 označující změnu stavu.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.attempted

Spouští se při pokusu o doručení e-mailu, který skončí dočasným selháním.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.attempted",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "attempted",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

status string

Vždy attempted.

meta object | null

Vlastní metadata připojená k e-mailu.

updated_at string

Časové razítko ve formátu ISO 8601 označující změnu stavu.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.failed

Spouští se, když se e-mail nepodaří doručit, obvykle kvůli konkrétní chybě během doručování.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.failed",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "failed",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

status string

Vždy failed.

meta object | null

Vlastní metadata připojená k e-mailu.

updated_at string

Časové razítko ve formátu ISO 8601 označující změnu stavu.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.rejected

Spouští se, když byl e-mail přijat k doručení, ale následně byl zamítnut.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.rejected",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "rejected",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

status string

Vždy rejected.

meta object | null

Vlastní metadata připojená k e-mailu.

updated_at string

Časové razítko ve formátu ISO 8601 označující změnu stavu.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.suppressed

Spuštěno, když je příjemce e-mailu na seznamu potlačených adres.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.suppressed",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "suppressed",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

status string

Vždy suppressed.

meta object | null

Vlastní metadata připojená k e-mailu.

updated_at string

Časové razítko ve formátu ISO 8601 označující změnu stavu.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.received

Spouští se při přijetí příchozího e-mailu.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.received",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

created_at string

Časové razítko ve formátu ISO 8601 udávající, kdy byl e-mail přijat.

email.complained

Spouští se, když je na tento e-mail podána stížnost (např. označen jako spam).

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.complained",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "complained",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor e-mailu.

object string

Vždy email.

from string

E-mailová adresa odesílatele.

to string

E-mailová adresa příjemce.

subject string

Předmět e-mailu.

status string

Vždy complained.

meta object | null

Vlastní metadata připojená k e-mailu.

updated_at string

Časové razítko ve formátu ISO 8601 označující změnu stavu.

created_at string

Časové razítko ve formátu ISO 8601 označující vytvoření e-mailu.

email.clicked

Spouští se při kliknutí na odkaz v e-mailu. Obsahuje podrobnosti o kliknutí, jako je IP adresa, user agent a URL, na kterou bylo kliknuto.

{
  "event_id": "...",
  "type": "email.clicked",
  "data": {
    "object": {
      "id": "click_4yM2nTvR8oPcX3u...",
      "object": "click",
      "email": {
        "id": "em_...",
        "rcpt_to": "recipient@example.com",
        "mail_from": "sender@example.com",
        "subject": "Welcome",
        "created_at": "...",
        "meta": null
      },
      "link": {
        "id": "link_...",
        "url": "https://example.com/page"
      },
      "ip_address": "203.0.113.42",
      "user_agent": "Mozilla/5.0 ...",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor kliknutí.

object string

Vždy click.

email object

E-mail, na který bylo kliknuto.

email.id string

Identifikátor e-mailu.

email.rcpt_to string

E-mailová adresa příjemce.

email.mail_from string

E-mailová adresa odesílatele.

email.subject string

Předmět e-mailu.

email.meta object | null

Vlastní metadata připojená k e-mailu.

link.id string

Identifikátor odkazu.

link.url string

URL, na kterou bylo kliknuto.

ip_address string

IP adresa kliknutí.

user_agent string

Řetězec user agent klienta.

created_at string

Časové razítko kliknutí ve formátu ISO 8601.

email.loaded

Spuštěno při načtení obsahu e-mailu příjemcem. Obsahuje sledovací údaje jako IP adresu a user agent.

{
  "event_id": "...",
  "type": "email.loaded",
  "data": {
    "object": {
      "id": "load_4yM2nTvR8oPcX3u...",
      "object": "load",
      "email": {
        "id": "em_...",
        "rcpt_to": "recipient@example.com",
        "mail_from": "sender@example.com",
        "subject": "Welcome",
        "created_at": "...",
        "meta": null
      },
      "ip_address": "203.0.113.42",
      "user_agent": "Mozilla/5.0 ...",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Pole

id string

Jedinečný identifikátor načtení.

object string

Vždy load.

email object

E-mail, který byl načten.

email.id string

Identifikátor e-mailu.

email.rcpt_to string

E-mailová adresa příjemce.

email.mail_from string

E-mailová adresa odesílatele.

email.subject string

Předmět e-mailu.

email.meta object | null

Vlastní metadata připojená k e-mailu.

ip_address string

IP adresa načtení.

user_agent string

Řetězec user agent klienta.

created_at string

Časové razítko načtení ve formátu ISO 8601.