Webhooks

email.clicked

Fires when the recipient clicks a tracked link in the email. Requires click tracking on the sending domain.

The email.clicked event fires whenever the recipient clicks a link in the email. It requires click tracking to be enabled on the sending domain.

The data.click object describes the click: the URL, the client's IP and user agent, and the timestamp.

{
  "type": "email.clicked",
  "created_at": "2026-06-22T23:41:12.126Z",
  "data": {
    "campaign_id": "8b146471-e88e-4322-86af-016cd36fd216",
    "created_at": "2026-06-22T23:41:11.894719+00:00",
    "email_id": "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794",
    "message_id": "<111-222-333@email.example.com>",
    "from": "Acme <onboarding@example.com>",
    "to": ["recipient@example.com"],
    "click": {
      "ipAddress": "122.115.53.11",
      "link": "https://example.com",
      "timestamp": "2026-06-24T05:00:57.163Z",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.1 Safari/605.1.15"
    },
    "subject": "Sending this example",
    "template_id": "43f68331-0622-4e15-8202-246a0388854b",
    "tags": {
      "category": "confirm_email"
    }
  }
}

Payload

typestringoptional

The event type that triggered the webhook.

created_atstringoptional

ISO 8601 timestamp when the webhook event was created.

dataobjectoptional

Event-specific data. The fields below live inside this object.

data.campaign_idstringoptional

Identifier for the campaign, if applicable.

data.created_atstringoptional

ISO 8601 timestamp when the email was created.

data.email_idstringoptional

Unique identifier for this email.

data.message_idstringoptional

RFC Message-ID header value for the email.

data.fromstringoptional

Sender address; may include a display name.

data.tostring[]optional

Recipient email address(es).

data.subjectstringoptional

Email subject line.

data.template_idstringoptional

Identifier of the template used, if applicable.

data.clickobjectoptional

Click tracking details (see below).

data.click.ipAddressstringoptional

IP address of the user who clicked the link.

data.click.linkstringoptional

The URL that was clicked.

data.click.timestampstringoptional

ISO 8601 timestamp when the click occurred.

data.click.userAgentstringoptional

User agent string of the browser that clicked the link.

data.tagsobjectoptional

Object of tag key-value pairs associated with the email.

This is one of several events MailBlastr can deliver. See the full list of webhook event types.