List events
GET
/v1/eventsEvery event in your account, a page at a time: the same events your webhooks get. Use it to poll when you can't receive webhooks, or to catch up after an outage.
Query parameters
-
limitintegerDefault25 -
cursorstring -
typestringOne ofdelivery.createddelivery.rejecteddelivery.notifieddelivery.openeddelivery.email_openeddelivery.auth_faileddelivery.confirmeddelivery.downloadeddelivery.delivereddelivery.remindeddelivery.bounceddelivery.expireddelivery.revokeddelivery.consignment_faileddelivery.evidence_sealeddelivery.evidence_timestamp_deferreddelivery.evidence_timestamp_recovereddelivery.paper_pending_approvaldelivery.paper_dispatcheddelivery.paper_faileddocument.previewedbatch.finalizedbatch.completedlookup.completedconsent.grantedconsent.withdrawninvitation.sentlink.openedotp.sentotp.verifiedotp.lockedsecret.attachedsecret.availablesecret.revealedsecret.copiedsecret.expiredsecret.exhaustedsecret.revokedrequest.sentrequest.openedrequest.fulfilledrequest.expiredrequest.closedrequest.reopeneddeletion.scheduledrecipient_domain.verifiedrecipient_domain.degradedrecipient_domain.failedmember.suspendedmember.restoredmember.removedbatch.cancelledbatch.policy_changeddelivery.policy_changedemail_sender.verifiedemail_sender.degradedemail_sender.failedemail_sender.restored -
created_afterstring · date-time -
created_beforestring · date-timeOnly events created strictly before this time. With created_after, a date range (as GET /deliveries).
-
resource_idstringOnly events about this resource (dlv_…, bat_…, req_…, …). Exact match.
-
orderstringasc, the default, is the order for polling: oldest first, walking forward with the cursor.desclists the newest first. A cursor works only with the order it came from.One ofascdescDefault"asc"
Returns
200 application/json. Paginated events.
Errors have one shape; see Errors for every code.