---
title: "Message opened"
method: POST
path: "message.opened"
---

# Message opened

`POST message.opened` (webhook)

## Payload

- object
  - `type` 'message.opened', required
  - `timestamp` string, required
  - `data` object, required
    - `messageId` string, required
    - `organizationId` string, required
    - `channel` 'email', required
    - `deliveryId` string, required
    - `recipient` string, required
    - `occurredAt` string, required
    - `userAgent` string, nullable
    - `ipAddress` string, nullable
    - `firstOpen` boolean, required
    - `machine` boolean, required
    - `machineReason` 'google-image-proxy' | 'apple-mail-privacy' | 'scanner-user-agent' | 'scanner-asn' | 'too-fast', nullable, required
    - `country` string, nullable
    - `city` string, nullable
    - `asn` number, nullable
    - `code` string, nullable
    - `linkIndex` number, nullable
    - `destinationUrl` string, nullable
    - `metadata` object, nullable
    - `campaignId` string, nullable
    - `campaignRunId` string, nullable

## Acknowledgement `200`

Any 2xx status acknowledges the event.

---

[API](https://skmtc.dev/samva/apis/samva-api.md) · [All operations](https://skmtc.dev/samva/apis/samva-api/llms.txt) · [OpenAPI document](https://skmtc.dev/samva/apis/samva-api/revisions/a99408542cc3?raw)