Eventi
Leggi il flusso di eventi alla base dei webhook: consegne, bounce, aperture e altro.
Elenca gli eventi
Restituisce gli eventi del workspace, a partire dal più recente. Ogni consegna webhook è costruita a partire da uno di questi eventi, quindi puoi usare questo endpoint per recuperare gli eventi che il tuo endpoint non ha ricevuto. Richiede una chiave API con il permesso full.
/eventsParametri di query
pageintegerNumero di pagina, a partire da 1. Predefinito 1. Le pagine oltre i 2500 eventi ((page - 1) × limit > 2500) restituiscono 422.
limitintegerEventi per pagina, da 1 a 100. Predefinito 100.
typestringIl tipo di evento, o un elenco di tipi separati da virgole, ad esempio email.delivered,email.bounced. Vedi Tipi di evento.
include_databooleanImposta true per includere il payload data di ogni evento. Predefinito false, che restituisce solo object, id, type e created_at.
matchstringall (predefinito) richiede che corrispondano tutti i filtri. or richiede che ne corrisponda almeno uno. Vedi Filtri e ordinamento.
orderstringChiave di ordinamento di questo elenco. Vedi le chiavi di ordinamento qui sotto.
directionstringasc o desc.
Filtri e ordinamento
I filtri degli elenchi sono un unico livello di parametri di query key.condition=value. Vedi Filtri e ordinamento per match, order, direction e l’elenco delle condizioni per tipo.
Chiavi di filtro
| Chiave | Tipo | Condizioni | Note |
|---|---|---|---|
type | string | exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty | |
created_at | date | exact, before, after, empty, not_empty |
Chiavi di ordinamento
Passa in order una di queste chiavi e in direction il valore asc o desc: type, created_at
Senza un filtro created_at, l’elenco copre solo gli ultimi 2 giorni. Per andare più indietro, aggiungine uno, ad esempio created_at.after=2026-09-01T00:00:00Z. Gli eventi più vecchi restano disponibili finché li mantiene la conservazione dei dati del piano.
Restituisce
Restituisce 200 OK con gli eventi in data, più next_page_url e previous_page_url (null alle due estremità). Gli URL delle pagine mantengono type, limit e include_data.
Restituisce 422 con code: "events_offset_too_large" quando la pagina è troppo profonda. Invece di andare oltre con le pagine, restringi l’intervallo di date o i tipi.
{
"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"
}Recupera un evento
Restituisce un evento con il suo payload data completo. L’id è lo stesso valore che i webhook inviano come event_id, quindi puoi consultare qualsiasi evento che hai ricevuto. Richiede una chiave API con il permesso full.
/events/:idParametri di percorso
idstringObbligatorioL’ID dell’evento, ad esempio evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a.
Restituisce
Restituisce 200 OK con l’evento: object (event), id, type, data e created_at. data.object ha la stessa forma del payload webhook per quel tipo; vedi i tipi di evento dei webhook.
Restituisce 404 con error: "Event not found" se l’ID non esiste nel workspace.
{
"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"
}