email.clicked

Fired when a link within an email is clicked. Includes click details such as IP address, user agent, and the URL that was clicked.

Payload

{
  "event_id": "...",
  "type": "email.clicked",
  "data": {
    "object": {
      "id": "click_4yM2nTvR8oPcX3u...",
      "object": "click",
      "email": {
        "id": "em_...",
        "rcpt_to": "recipient@example.com",
        "mail_from": "sender@example.com",
        "subject": "Welcome",
        "created_at": "...",
        "meta": null
      },
      "link": {
        "id": "link_...",
        "url": "https://example.com/page"
      },
      "ip_address": "203.0.113.42",
      "user_agent": "Mozilla/5.0 ...",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Fields

idstring
Link

Unique click identifier.

objectstring
Link

Always click.

emailobject
Link

The email that was clicked.

email.idstring
Link

Email identifier.

email.rcpt_tostring
Link

Recipient email address.

email.mail_fromstring
Link

Sender email address.

email.subjectstring
Link

Email subject line.

email.metaobject | null
Link

Custom metadata attached to the email.

link.idstring
Link

Link identifier.

link.urlstring
Link

The URL that was clicked.

ip_addressstring
Link

IP address of the click.

user_agentstring
Link

User agent string of the client.

created_atstring
Link

ISO 8601 timestamp of the click.