Webhook Events

Email opened

A mail client loaded the open pixel of a message sent with trackOpens: true.

Opens are a signal, not proof of reading:

  • Gmail and Apple Mail fetch images through their own proxies, some as soon as the mail arrives.
  • Clients that block images never report an open.
  • The sender viewing the message in their own Sent folder counts too.

Repeat fetches within 10 seconds raise count without firing again.

postWebhookemail.opened

Payload

idstring required
testboolean

Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.

event'email.opened' required
timestampstring date-time required

Example payload

{
  "profiles": [
    {
      "externalId": "tenant_42"
    }
  ]
}

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.