Přejít na obsah
Dokumentace

Události odběratelů

Kontakty přidané do seznamu, v něm změněné, do něj znovu přidané nebo z něj odebrané.

subscriber.created

Odesílá se, když se kontakt přidá do seznamu kontaktů přes endpoint Přidání odběratele, nebo když vytvoříte či upravíte kontakt s polem audiences. Přidání kontaktu, který se ze seznamu dříve odhlásil, místo toho vyvolá subscriber.updated a subscriber.resubscribed.

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 subscriber.created.

objectobject

Odběratel, kterého se událost týká. Jeho 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 odběratele

idstring

ID odběratele (sub_…). Odběratel je členství jednoho kontaktu v jednom seznamu kontaktů.

objectstring

Vždy subscriber.

subscribedboolean

Jestli je kontakt v seznamu kontaktů přihlášený k odběru.

subscribed_atstring | null

Kdy se kontakt přihlásil, nebo null.

unsubscribed_atstring | null

Kdy se kontakt odhlásil, nebo null.

audienceobject

id a name seznamu kontaktů.

contactobject

Kontakt: id, email, first_name, last_name a custom_fields.

created_atstring

Kdy byl kontakt přidán do seznamu kontaktů, ve formátu ISO 8601 s posunem vůči UTC.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.created",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": true,
    "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
    "unsubscribed_at": null,
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "created_at": "2026-09-20T14:22:09.418302+00:00"
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": true,
      "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
      "unsubscribed_at": null,
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "created_at": "2026-09-20T14:22:09.418302+00:00"
    }
  }
}

subscriber.updated

Odesílá se, když se odběratel změní: upravíte ho přes endpoint Úprava odběratele, kontakt se odhlásí či znovu přihlásí nebo se do seznamu kontaktů znovu přidá kontakt, který se dříve odhlásil. Pokud změnu způsobilo odhlášení nebo opětovné přihlášení, obsahuje pole previous původní hodnoty.

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 subscriber.updated.

objectobject

Odběratel, kterého se událost týká. Jeho 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 odběratele

idstring

ID odběratele (sub_…). Odběratel je členství jednoho kontaktu v jednom seznamu kontaktů.

objectstring

Vždy subscriber.

subscribedboolean

Jestli je kontakt v seznamu kontaktů přihlášený k odběru.

subscribed_atstring | null

Kdy se kontakt přihlásil, nebo null.

unsubscribed_atstring | null

Kdy se kontakt odhlásil, nebo null.

audienceobject

id a name seznamu kontaktů.

contactobject

Kontakt: id, email, first_name, last_name a custom_fields.

updated_atstring

Kdy byl odběratel naposledy upraven, ve formátu ISO 8601 s posunem vůči UTC.

created_atstring

Kdy byl kontakt přidán do seznamu kontaktů.

previousobject

Původní hodnoty, uvedené, pokud se kontakt odhlásil nebo znovu přihlásil: subscribed a unsubscribed_at. U ostatních změn chybí.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.updated",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": false,
    "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
    "unsubscribed_at": "2026-10-01T10:02:14.000000+00:00",
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "updated_at": "2026-10-01T10:02:14.307000+00:00",
    "created_at": "2026-09-20T14:22:09.418302+00:00",
    "previous": {
      "subscribed": true,
      "unsubscribed_at": null
    }
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": false,
      "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
      "unsubscribed_at": "2026-10-01T10:02:14.000000+00:00",
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "updated_at": "2026-10-01T10:02:14.307000+00:00",
      "created_at": "2026-09-20T14:22:09.418302+00:00",
      "previous": {
        "subscribed": true,
        "unsubscribed_at": null
      }
    }
  }
}

subscriber.resubscribed

Odesílá se, když přes endpoint Přidání odběratele přidáte kontakt do seznamu kontaktů, ze kterého se odhlásil. Emailit odešle také subscriber.updated se stejným odběratelem.

Událost subscriber.resubscribed v seznamu událostí ve webovém rozhraní není. Dostanete ji u webhooků se zapnutým all_events, nebo když ji přidáte do pole events přes endpoint Úprava webhooku.

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 subscriber.resubscribed.

objectobject

Odběratel, kterého se událost týká. Jeho 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 odběratele

idstring

ID odběratele (sub_…). Odběratel je členství jednoho kontaktu v jednom seznamu kontaktů.

objectstring

Vždy subscriber.

subscribedboolean

Jestli je kontakt v seznamu kontaktů přihlášený k odběru.

subscribed_atstring | null

Kdy se kontakt přihlásil, nebo null.

unsubscribed_atstring | null

Kdy se kontakt odhlásil, nebo null.

audienceobject

id a name seznamu kontaktů.

contactobject

Kontakt: id, email, first_name, last_name a custom_fields.

updated_atstring

Kdy byl odběratel naposledy upraven, ve formátu ISO 8601 s posunem vůči UTC.

created_atstring

Kdy byl kontakt přidán do seznamu kontaktů.

resubscribedboolean

Vždy true.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.resubscribed",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": true,
    "subscribed_at": "2026-10-01T10:02:14.307000+00:00",
    "unsubscribed_at": null,
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "updated_at": "2026-10-01T10:02:14.307000+00:00",
    "created_at": "2026-09-20T14:22:09.418302+00:00",
    "resubscribed": true
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": true,
      "subscribed_at": "2026-10-01T10:02:14.307000+00:00",
      "unsubscribed_at": null,
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "updated_at": "2026-10-01T10:02:14.307000+00:00",
      "created_at": "2026-09-20T14:22:09.418302+00:00",
      "resubscribed": true
    }
  }
}

subscriber.deleted

Odesílá se, když se kontakt odebere ze seznamu kontaktů: přes endpoint Smazání odběratele, když změníte pole audiences kontaktu nebo když kontakt smažete. Obsahem je odběratel ve stavu před odebrá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 subscriber.deleted.

objectobject

Odběratel, kterého se událost týká. Jeho 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 odběratele

idstring

ID odběratele (sub_…). Odběratel je členství jednoho kontaktu v jednom seznamu kontaktů.

objectstring

Vždy subscriber.

subscribedboolean

Jestli je kontakt v seznamu kontaktů přihlášený k odběru.

subscribed_atstring | null

Kdy se kontakt přihlásil, nebo null.

unsubscribed_atstring | null

Kdy se kontakt odhlásil, nebo null.

audienceobject

id a name seznamu kontaktů.

contactobject

Kontakt: id, email, first_name, last_name a custom_fields.

updated_atstring

Kdy byl odběratel naposledy upraven, ve formátu ISO 8601 s posunem vůči UTC.

created_atstring

Kdy byl kontakt přidán do seznamu kontaktů.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.deleted",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": true,
    "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
    "unsubscribed_at": null,
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "updated_at": "2026-09-20T14:22:09.418302+00:00",
    "created_at": "2026-09-20T14:22:09.418302+00:00"
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": true,
      "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
      "unsubscribed_at": null,
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "updated_at": "2026-09-20T14:22:09.418302+00:00",
      "created_at": "2026-09-20T14:22:09.418302+00:00"
    }
  }
}

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

Děkujeme za zpětnou vazbu.

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

Esc

Oblíbené

↑↓procházet↵otevřítEsczavřít