boundry.
RegionSydney, Australia
Documentation/email.clicked

email.clicked

A signed Boundry platform event. Its payload remains pinned to the API version configured for the receiving endpoint.

email.clicked

A tracked link was followed.

Channel: email

Payload schema

FieldTypeDescription
api_versionrequiredstring

API version pinned to the webhook endpoint. Values: "2026-08-14". Default: "2026-08-14".

created_atrequiredstring (date-time)

Timestamp when Boundry created the event. Example: "2026-08-14T12:00:00.000Z".

datarequiredobject

Event resource wrapper. Example: {"object":{"attachments":[],"bcc":[],"cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","engaged_at":"2026-08-14T12:01:00.000Z","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"clicked","link":"https://acme.com/welcome","message_id":"<010001@example>","object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"],"user_agent":"Mozilla/5.0"}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","engaged_at":"2026-08-14T12:01:00.000Z","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"clicked","link":"https://acme.com/welcome","message_id":"<010001@example>","object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"],"user_agent":"Mozilla/5.0"}.

attachmentsrequiredarray

Attachment metadata.

content_typerequiredstring

Attachment media type. Example: "application/pdf".

filenamerequiredstring

Original attachment filename. Example: "invoice.pdf".

idrequiredstring

Attachment identifier. Example: "msg_01j0example".

sizerequiredinteger

Attachment size in bytes. Example: 1234.

bccrequiredarray

Blind-carbon-copy recipients.

ccrequiredarray

Carbon-copy recipients.

channelrequiredstring

Messaging channel. Values: "email".

created_atrequiredstring (date-time)

Timestamp when Boundry accepted the message. Example: "2026-08-14T12:00:00.000Z".

engaged_atrequiredstring (date-time)

Timestamp when the tracking pixel was loaded. Example: "2026-08-14T12:00:00.000Z".

fromrequiredstring

Sender email address. Example: "hello@example.com".

htmlrequiredstring | null | null

HTML body, or null when omitted.

Option 1string

HTML email content.

Option 2null | null

One permitted response shape.

idrequiredstring

Message identifier. Example: "msg_01j0example".

last_eventrequiredstring

Latest delivery lifecycle event. Values: "queued", "scheduled", "sending", "sent", "delivered", "delivery_delayed", "bounced", "complained", "opened", "clicked", "failed", "canceled", "received", "stored".

linkrequiredstring (uri)

Tracked link followed by the recipient.

message_idrequiredstring | null | null

Provider message identifier, or null before delivery.

Option 1string

Provider message identifier.

Option 2null | null

One permitted response shape.

objectrequiredstring

Resource type discriminator. Values: "email". Example: "email".

project_idrequiredstring

Owning project identifier. Example: "msg_01j0example".

reply_torequiredarray

Reply-to addresses.

scheduled_atrequirednull | null

Scheduled delivery time; local mode does not schedule emails.

subjectrequiredstring

Email subject. Example: "Welcome to Boundry".

tagsrequiredarray

Email tags.

namerequiredstring

Tag name. Example: "campaign".

valuerequiredstring

Tag value. Example: "welcome".

textrequiredstring | null | null

Plain-text body, or null when omitted.

Option 1string

Plain-text email content.

Option 2null | null

One permitted response shape.

torequiredarray

Recipient email addresses.

user_agentrequiredstring | null | null

Recipient user-agent, or null when unavailable.

Option 1string

Recipient user-agent string.

Option 2null | null

One permitted response shape.

idrequiredstring

Stable event identifier.

livemoderequiredboolean

Whether the event originated in live mode.

objectrequiredstring

Resource type discriminator. Values: "event".

project_idrequiredstring

Owning project identifier. Example: "msg_01j0example".

typerequiredstring

Webhook event type. Values: "email.clicked".

Sample body

email.clicked event
json
{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "channel": "email",
      "created_at": "2026-08-14T12:00:00.000Z",
      "engaged_at": "2026-08-14T12:01:00.000Z",
      "from": "sender@acme.com",
      "html": null,
      "id": "msg_01j0example",
      "last_event": "clicked",
      "link": "https://acme.com/welcome",
      "message_id": "<010001@example>",
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ],
      "user_agent": "Mozilla/5.0"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.clicked"
}
Verify signed webhook deliveries →