WEBHOOK
message.opened
{
  "type": "message.opened",
  "timestamp": "2024-05-06T10:15:16.687031577Z",
  "data": {
    "account_id": "4cdd7bdd-294e-4762-892f-83d40abf5a87",
    "event": "on_opened",
    "from": "[email protected]",
    "recipient": "[email protected]",
    "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

Response

Webhook received successfully