Přejít na obsah
Dokumentace

Vytvořené, změněné, naplánované, odeslané, zrušené, archivované nebo smazané kampaně.

campaign.created

Odesílá se, když se kampaň vytvoří přes endpoint Vytvoření kampaně nebo ve webovém rozhraní, a to i při duplikování kampaně. Nové kampaně začínají ve stavu draft.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.created.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Vždy draft.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.created",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00"
    }
  }
}

campaign.updated

Odesílá se, když se změní obsah nebo nastavení kampaně, například přes endpoint Úprava kampaně, nebo když se kampaň vrátí do stavu draft, protože jste zrušili její naplánování nebo ve webovém rozhraní zrušili její archivaci. Pokud se změnil stav, obsahuje pole previous_status původní stav.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.updated.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Aktuální stav: draft, scheduled, queued, sending, sent, canceled nebo archived.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

previous_statusstring

Stav před změnou. Uvádí se, jen pokud se stav změnil.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.updated",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "scheduled"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "scheduled"
    }
  }
}

campaign.scheduled

Odesílá se, když naplánujete koncept kampaně přes endpoint Odeslání nebo naplánování kampaně s budoucím časem v poli scheduled_at, nebo ve webovém rozhraní. Viz Testování a naplánování kampaně.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.scheduled.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Vždy scheduled.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

previous_statusstring

Stav před změnou, obvykle draft.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.scheduled",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "scheduled",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "scheduled",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.queued

Odesílá se, když nastane čas odeslání naplánované kampaně a Emailit ji zařadí do fronty. Jakmile odesílání začne, následuje campaign.sending.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.queued.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Vždy queued.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

previous_statusstring

Vždy scheduled.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.queued",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "queued",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "scheduled"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "queued",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "scheduled"
    }
  }
}

campaign.sending

Odesílá se, když Emailit začne odesílat kampaň: hned, když ji odešlete přes endpoint Odeslání nebo naplánování kampaně nebo z webového rozhraní, nebo když se spustí naplánovaná kampaň zařazená do fronty.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.sending.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Vždy sending.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

previous_statusstring

draft, pokud jste kampaň odeslali hned, queued u naplánované kampaně.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.sending",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "sending",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:00:03.214000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "sending",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:00:03.214000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.sent

Odesílá se, když Emailit vytvoří a zařadí do fronty e-mail pro každého přihlášeného příjemce kampaně. Události doručení, otevření a prokliků jednotlivých e-mailů následují průběžně, jak nastávají. Viz Reporty kampaní.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.sent.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Vždy sent.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

previous_statusstring

Vždy sending.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.sent",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "sent",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:04:51.000000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "sending"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "sent",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:04:51.000000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "sending"
    }
  }
}

campaign.canceled

Odesílá se, když zrušíte kampaň přes endpoint Zrušení kampaně. Zrušit lze jen kampaně ve stavu draft a sending.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.canceled.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Vždy canceled.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

previous_statusstring

draft, nebo sending.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.canceled",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "canceled",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "canceled",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.archived

Odesílá se, když ve webovém rozhraní archivujete odeslanou kampaň. Zrušení archivace ji vrátí do stavu draft a vyvolá campaign.updated s polem previous_status nastaveným na archived.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.archived.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Vždy archived.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

previous_statusstring

Vždy sent.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.archived",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "archived",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:04:51.000000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "sent"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "archived",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:04:51.000000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "sent"
    }
  }
}

campaign.deleted

Odesílá se, když se kampaň smaže přes endpoint Smazání kampaně nebo ve webovém rozhraní. Obsahem je kampaň ve stavu, v jakém byla před smazáním.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy campaign.deleted.

objectobject

Kampaň, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt kampaně

idstring

ID kampaně (cmp_…).

objectstring

Vždy campaign.

namestring

Název kampaně.

statusstring

Stav, který kampaň měla v okamžiku smazání.

subjectstring

Předmět, nebo prázdný řetězec, pokud ještě není nastavený.

from_emailstring

Adresa odesílatele, nebo prázdný řetězec.

from_namestring

Jméno odesílatele, nebo prázdný řetězec.

scheduled_atstring | null

Kdy je kampaň naplánovaná k odeslání, nebo null.

sent_atstring | null

Kdy byla kampaň odeslána, nebo null.

created_atstring

Kdy byla kampaň vytvořena, ve formátu ISO 8601 s posunem vůči UTC.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.deleted",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00"
    }
  }
}

Byla tato stránka užitečná?

Děkujeme za zpětnou vazbu.

Děkujeme, čteme každou zprávu.