FlaresendDocs
Events

List events

Every timeline event in the project, newest first.

GET/v1/eventsAPI key

Returns timeline events across all of the project's emails, newest first, paginated. It is the same data webhooks deliver, so you can use it to catch up on events you missed or to poll instead of running a webhook endpoint.

Query parameters

limitnumberquerydefault: 25

1 to 100.

cursorstringquery

The nextCursor from the previous page.

typestringquery

Only this event type, for example email.bounced. The types are email.queued, email.scheduled, email.sent, email.retrying, email.delivered, email.deferred, email.bounced, email.complained, email.rejected, email.failed, email.test, email.canceled, email.opened and email.clicked.

emailIdstringquery

Only events of this email.

sincestringquery

Only events at or after this ISO 8601 date-time. Needs a time zone offset.

Response

dataEvent[]
Show event properties
idstring

The event ID, evt_….

emailIdstring

The email it belongs to.

projectIdstring

The project.

typestring

The event type.

recipientstring | null

The address the event is about, or null for events about the whole email.

dataobject | null

Details that depend on the type. See Retrieve an email.

createdAtstring

When it happened.

nextCursorstring | null

Pass it as cursor for the next page. null on the last page.

Errors

StatusCodeWhen
400invalid_querylimit is out of range or since isn't a date-time with an offset.