Message processed

{ "timestamp": "2023-11-07T05:31:56Z", "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "eventType": "processed", "recipients": [ "<string>" ], "subject": "<string>", "tags": [ "<string>" ], "metadata": {} }

Headers

X-Helo-Webhook-Signature

string

required

HMAC-SHA256 signature of the request, formatted as t={timestamp},v1={signature}. Verify it against the webhook's signing key to authenticate the delivery.

X-Helo-Webhook-Event-Id

string<uuid>

required

Unique identifier of the event, useful for idempotent processing.

X-Helo-Webhook-Test

enum<string>

Set to true when the delivery is a test, otherwise omitted.

Available options:

true

Body

application/json

Payload delivered for the processed event.

timestamp

string<date-time>

required

When the event occurred (ISO 8601 / RFC 3339).

messageId

string<uuid>

required

Unique identifier of the message the event relates to.

channelId

string<uuid>

required

Unique identifier of the channel the message was sent from.

mailType

enum<string>

required

Available options:

transactional,

broadcast

eventType

enum<string>

required

Available options:

processed

recipients

string[]

required

The recipients the message was sent to.

subject

string

Subject line of the message.

Response

2XX

Return any 2XX status code to acknowledge receipt.

Getting started

API endpoints

Message processed

Headers

Body

Response