Webhook event · Tracking

tracking_preferences_updated

Sent when a recipient changes their open or click tracking choice on the tracking preferences page. They keep receiving your emails: this is not an unsubscribe.

i

Delivered as a signed POST to your webhook URL. See Setup & Events for how to verify the signature.

Payload

// Turned open tracking off (API / SMTP email)
{
  "event": "tracking_preferences_updated",
  "timestamp": "2026-10-24T07:20:12.031Z",
  "data": {
    "recipientEmail": "jane.doe@example.com",
    "trackOpens": false,
    "trackClicks": true,
    "source": "page",
    "updatedAt": "2026-10-24T07:20:12.031Z",
    "trackId": "a41f9c0e7b2d58e6"
  }
}
!

Only when something changed Saving the same choice again does not send the webhook. Changes you make yourself with Set Preferences are not sent either, so your CRM sync never loops. A refusal is applied to your sends right away: emails sent with "unsubscribe": true leave out the pixel and the tracked links for that recipient.

i

Tracking Preferences API Read one recipient or 100 at once, see the full history of a recipient, and poll every change with a cursor.

Tracking Preferences →

Field reference

  • event

    Fixed value: "tracking_preferences_updated"

  • timestamp

    When the change was processed (ISO 8601, UTC).

  • data.recipientEmail

    The recipient who changed their preference.

  • data.trackOpens

    true: the recipient allows open tracking. false: they refused it.

  • data.trackClicks

    true: the recipient allows click tracking. false: they refused it.

  • data.source

    Fixed value for now: "page" (the recipient used the tracking preferences page).

  • data.updatedAt

    When the preference was saved (ISO 8601, UTC). The same value as updated_at in the API.

  • data.campaignId

    The campaign of the email the recipient came from. Only for campaign emails.

  • data.trackId

    Tracking key of the email, for emails sent through the API or SMTP. Only when tracking was on for that send.