Take a batch of events

GEThttps://api.torvathmail.com/v1/events

Events must be turned on under Admin → API → Events first. How the queue works is in Events queue; the fields of each event type are in Webhooks.

Returns up to limit events, oldest first, and hides them for 60 seconds. Acknowledge each one you handled with its receipt; the rest come back. With wait, the request waits up to that many seconds for events to arrive.

Query parameters

waitintegeroptional0 to 20default 0
limitintegeroptional1 to 100default 50
typesstringoptional
Comma-separated event types; others are left for other consumers.

Response

eventsarray of objectsrequired
Fields inside events
- idstringrequired
- typestringrequired
  One ofemail.sentemail.deliveredemail.bouncedemail.complainedemail.failedemail.openedemail.clicked
- createdAtintegerrequired
- emailIdstringrequired
- recipientstringrequired
- tagsarray of stringsrequired
- metadataobjectrequiredstring values
- attemptintegerrequired
  How many times this event has been fetched
- receiptstringrequired
  Acknowledge with this
- categorystringoptional
  email.bounced, email.failed
- reasonstringoptional
  email.bounced, email.failed
- titlestringoptional
- smtpCodeinteger or nulloptional
- statusstring or nulloptional
- diagnosticstring or nulloptional
- feedbackTypestring or nulloptional
  email.complained
- machinebooleanoptional
  email.opened, email.clicked: likely a machine, not a person
- urlstringoptional
  email.clicked

Status codes

200
A batch (empty when none arrived)
401
No API key, or it isn't valid or was revoked.unauthorized
403
The key or plan doesn't allow this.forbiddenapi_offneeds_business
409
Your organisation's settings or state stop it.events_offdomain_blockedstorage_fullorg_inactive

Refusals share one shape. See errors.