Email event

POST

What Vaartix sends to your endpoint. Verify the webhook-signature header before trusting the body (see the Webhooks guide), answer with any 2xx status within 10 seconds, and do slow work afterwards. Other responses are retried for about 24 hours.

Authorizations

• apiKey

Parameters

Header Parameters

webhook-id

required

string

Example

whd_8m3k1q7v2c9x4d6p

Unique per delivery and the same on every retry. Use it to ignore duplicates.

webhook-timestamp

required

string

Example

1793181600

Unix time in seconds when this attempt was signed.

webhook-signature

required

string

v1, followed by the base64 HMAC-SHA256 of webhook-id.webhook-timestamp.body.

Request Body^required

Media typeapplication/json

object

type

required

string

Allowed values: email.sent email.delivered email.delivery_delayed email.bounced email.complained email.rejected email.rendering_failure email.suppressed email.opened email.clicked

createdAt

required

When the event happened.

string format: date-time

data

required

object

emailId

string

Example

em_7hq2kv9xr4m1c8d3

eventId

string

Example

evt_2m9k4q7v1c8x3d6p

recipient

The address this event is about, for per-recipient events.

string | null

Example

[email protected]

from

string

Example

Acme <[email protected]>

to

Array<string>

cc

Array<string>

bcc

Array<string>

subject

string

Example

Your login code

tags

Array<object>

object

name

string

value

string

emailCreatedAt

string format: date-time

details

Event details, such as the bounce type or SMTP response from the mail provider. For email.delivery_delayed it is a DelayedEventDetails, for email.bounced a BouncedEventDetails, for email.opened an OpenedEventDetails, for email.clicked a ClickedEventDetails.

object

key

additional properties

any

Responses

200

Any 2xx response marks the delivery as succeeded.