{
  "type": "message.opened",
  "webhook_id": "abe11757-2886-4b55-96f1-0e0afc95795a",
  "timestamp": "2024-05-06T10:15:16.687031577Z",
  "data": {
    "account_id": "4cdd7bdd-294e-4762-892f-83d40abf5a87",
    "event": "on_opened",
    "from": "sender@example.com",
    "recipient": "recipient@example.com",
    "subject": "Welcome to our service",
    "message_id_header": "<message-id-12345@localhost>",
    "id": "407926766d2711f09b30960002cafe7c",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
    "ip": "192.168.1.100",
    "is_bot": false
  }
}

Message Events

Message Opened Webhook

Triggered when the recipient opens your email.

Requirements:

Open tracking must be enabled for your account or this specific email
The email must contain HTML content
The recipient’s email client must load images

Additional Data: This webhook includes user agent and IP address information for analytics.

Bot Detection: The is_bot field indicates whether the open was detected as automated (email security scanners, etc.).

When it’s sent: When the tracking pixel in the email is loaded.

WEBHOOK

message.opened

{
  "type": "message.opened",
  "webhook_id": "abe11757-2886-4b55-96f1-0e0afc95795a",
  "timestamp": "2024-05-06T10:15:16.687031577Z",
  "data": {
    "account_id": "4cdd7bdd-294e-4762-892f-83d40abf5a87",
    "event": "on_opened",
    "from": "sender@example.com",
    "recipient": "recipient@example.com",
    "subject": "Welcome to our service",
    "message_id_header": "<message-id-12345@localhost>",
    "id": "407926766d2711f09b30960002cafe7c",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
    "ip": "192.168.1.100",
    "is_bot": false
  }
}

Body

application/json

type

enum<string>

required

The event type

Available options:

message.opened

webhook_id

string<uuid>

required

The webhook ID (the same ID as returned by the Create Webhook API)

timestamp

string<date-time>

required

When the event occurred (ISO 8601 format)

data

object

required

Show child attributes

Response

Webhook received successfully

Suppressed Clicked