Události
Čtěte proud událostí, ze kterého vycházejí webhooky: doručení, nedoručení, otevření a další.
Výpis událostí
Vrátí události ve vašem workspace od nejnovějších. Každé doručení webhooku vychází z jedné z těchto událostí, takže přes tento endpoint můžete dodatečně načíst události, které váš endpoint zmeškal. Vyžaduje API klíč s oprávněním full.
/eventsParametry dotazu
pageintegerČíslo stránky, od 1. Výchozí hodnota je 1. Stránky hlubší než 2 500 událostí ((page - 1) × limit > 2500) vracejí 422.
limitintegerPočet událostí na stránce, od 1 do 100. Výchozí hodnota je 100.
typestringTyp události, nebo seznam typů oddělených čárkami, například email.delivered,email.bounced. Viz Typy událostí.
include_databooleanNastavte na true, pokud chcete u každé události i obsah data. Výchozí hodnota false vrací jen object, id, type a created_at.
matchstringHodnota all (výchozí) vyžaduje shodu se všemi filtry. S hodnotou or stačí shoda s kterýmkoli filtrem. Viz Filtrování.
orderstringKlíč řazení pro tento výpis. Viz klíče řazení níže.
directionstringasc, nebo desc.
Filtry a řazení
Filtry výpisů jsou jedna úroveň parametrů dotazu ve tvaru key.condition=value. Parametry match, order a direction a seznam podmínek pro každý typ najdete na stránce Filtrování.
Klíče filtrů
| Klíč | Typ | Podmínky | Poznámky |
|---|---|---|---|
type | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | |
created_at | date | exact, before, after, empty, not_empty |
Klíče řazení
V parametru order předejte jeden z těchto klíčů a v parametru direction hodnotu asc, nebo desc: type, created_at
Bez filtru created_at pokrývá výpis jen poslední 2 dny. Pokud chcete jít dál do minulosti, filtr přidejte, například created_at.after=2026-09-01T00:00:00Z. Starší události jsou dostupné tak dlouho, dokud je drží uchovávání dat vašeho tarifu.
Odpověď
Vrací 200 OK s událostmi v poli data a navíc next_page_url a previous_page_url (na začátku a na konci null). URL stránek zachovávají type, limit a include_data.
Pokud je stránka příliš hluboko, vrací 422 s code: "events_offset_too_large". Místo dalšího stránkování zužte časové období nebo typy.
{
"data": [
{
"object": "event",
"id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
"type": "email.delivered",
"created_at": "2026-10-01T10:02:15.912000+00:00"
}
],
"next_page_url": "/v2/events?page=2&limit=100&type=email.delivered",
"previous_page_url": null
}{
"data": [
{
"object": "event",
"id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
"type": "email.delivered",
"data": {
"object": {
"id": "em_2xLc8Mm3Pq5Vn0Ra7Jt2Wd9Fb4e",
"object": "email",
"from": "hello@acme.com",
"to": "ada@example.com",
"subject": "Your order has shipped",
"status": "delivered",
"meta": { "order_id": "1042" },
"updated_at": "2026-10-01T10:02:14.307000+00:00",
"created_at": "2026-10-01T10:02:11.583000+00:00"
}
},
"created_at": "2026-10-01T10:02:15.912000+00:00"
}
],
"next_page_url": "/v2/events?page=2&limit=100&type=email.delivered&include_data=true",
"previous_page_url": null
}{
"error": "Page is too deep. Narrow the type or date filter, or open an earlier page.",
"code": "events_offset_too_large"
}Načtení události
Vrátí jednu událost s úplným obsahem data. id je stejná hodnota, kterou webhooky posílají jako event_id, takže můžete dohledat jakoukoli přijatou událost. Vyžaduje API klíč s oprávněním full.
/events/:idParametry v cestě
idstringPovinnéID události, například evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a.
Odpověď
Vrací 200 OK s událostí: object (event), id, type, data a created_at. data.object má stejný tvar jako v obsahu webhooku pro daný typ; viz referenci událostí webhooků.
Pokud ID ve vašem workspace neexistuje, vrací 404 s error: "Event not found".
{
"object": "event",
"id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
"type": "email.delivered",
"data": {
"object": {
"id": "em_2xLc8Mm3Pq5Vn0Ra7Jt2Wd9Fb4e",
"object": "email",
"from": "hello@acme.com",
"to": "ada@example.com",
"subject": "Your order has shipped",
"status": "delivered",
"meta": { "order_id": "1042" },
"updated_at": "2026-10-01T10:02:14.307000+00:00",
"created_at": "2026-10-01T10:02:11.583000+00:00"
}
},
"created_at": "2026-10-01T10:02:15.912000+00:00"
}{
"error": "Event not found"
}