Naar de inhoud

API-documentatie

Events API

Haal gebeurtenissen op over uw e-mail en de toepassing, zoals aflevering, bounces, klachten en tweestapsverificatie, met de bijbehorende gegevens. De resultaten zijn gepagineerd.

Versie
3.0

Basis-URL

  • Testhttps://test-public-api.secumail.nl/event/v3
  • Productiehttps://public-api.secumail.nl/event/v3

Authenticatie

  • API-sleutel in de header x-api-key

Een API-sleutel of toegangsgegevens vraagt u aan via contact.

Endpoints

GET/event

Get event data

Returns event data for all domains belonging to the authenticated account, or for one or more domains specified explicitly. Results can be filtered by time range and event type, and paginated either by offset (via 'search_from'/'size') or by cursor (via 'search_after').

Parameters

NaamInTypeOmschrijving
search_fromqueryinteger

The document number from which to start showing results. Results are zero-indexed, so the first page of a series of paginated requests should use 0. Works together with the optional 'size' parameter. Defaults to 0 when omitted.

sizequeryinteger
date_start *querystring

Start datetime for the search, in ISO 8601 extended format. The timezone must be either 'Z' or a ':'-delimited UTC offset (e.g. '+02:00'). Offsets without a colon (e.g. '+0200') are rejected.

date_endquerystring

End datetime for the search, in the same ISO 8601 extended format as 'date_start'. If omitted, defaults to the current datetime. Must not precede 'date_start'.

domainqueryarray

The domain or domains to filter events by. Every domain supplied must belong to the authenticated account, or the request is rejected with 403. If omitted, events for all domains belonging to the account are returned.

event_typequerystring

Filter for a specific event type. Matching is exact but case-insensitive, and is not limited to the standard mail lifecycle types (e.g. 'send', 'delivery', 'bounce', 'complaint') - any event type the account has data for is supported, including application-specific event types that contain hyphens (e.g. 'transaction-completed'). If omitted, results include all event types. For a list of supported event types, refer to https://legalbot.atlassian.net/wiki/spaces/SEC/pages/2177105921/Kibana+events

search_afterquerystring

Cursor for pagination, as an alternative to 'search_from'/'size'. Pass the 'sort' value of the last event from a previous response, serialized as a comma-separated list, to fetch results starting immediately after that event. Must contain exactly two comma-separated values.

Responses

  • 200

    OK

  • 400

    Bad Request. Your request contains errors.

  • 403

    Forbidden. Returned by the application when the API key is not associated with an account, has no mailbox or domain bindings, or one or more requested domains do not belong to the account (body: a ProblemDetails object). When no API key is provided at all, a simpler message is returned (body: {"message": "Forbidden"}).

  • 500

Velden met * zijn verplicht. De technische omschrijvingen komen uit de OpenAPI-specificatie en zijn in het Engels.

Koppeling bespreken?

Benieuwd hoe SecuMailer aansluit op uw applicatie?

Plan een gratis demo. We bespreken uw situatie en de beste manier om te koppelen.

Plan een gratis demo