Documentation/events

Platform events

Every event is generated from the Boundry event catalog. Subscribe to an exact type, a namespace wildcard such as email.*, or * for every present and future platform event.

TypeSummaryChannelPayload schemaSample body

email.queuedBoundry accepted the email and queued it.

email

View schema

View sample

email.scheduledThe email is held for a future send time.

email

View schema

View sample

email.sendingHanded to the regional transport.

email

View schema

View sample

email.sentAccepted for delivery by the transport.

email

View schema

View sample

email.deliveredThe recipient server accepted the message.

email

View schema

View sample

email.delivery_delayedA recipient server deferred the message; retries continue.

email

View schema

View sample

email.bouncedPermanently rejected.

email

View schema

View sample

email.complainedThe recipient marked the message as spam.

email

View schema

View sample

email.openedA tracking pixel was loaded.

email

View schema

View sample

email.clickedA tracked link was followed.

email

View schema

View sample

email.failedBoundry could not send the message.

email

View schema

View sample

email.canceledA scheduled email was cancelled before sending.

email

View schema

View sample

email.receivedInbound mail was accepted for a receiving domain.

email

View schema

View sample

email.storedInbound mail was persisted in the regional data plane.

email

View schema

View sample

domain.createdA domain was attached to the project.

domain

View schema

View sample

domain.verifiedAll required DNS records were observed.

domain

View schema

View sample

domain.verification_failedDNS verification did not pass.

domain

View schema

View sample

domain.updatedDomain capabilities or tracking changed.

domain

View schema

View sample

domain.deletedA domain was detached from the project.

domain

View schema

View sample

api_key.createdA project API key was issued.

api_key

View schema

View sample

api_key.revokedA project API key was revoked.

api_key

View schema

View sample

webhook.endpoint.createdA webhook endpoint was created.

webhook

View schema

View sample

webhook.endpoint.updatedA webhook endpoint changed.

webhook

View schema

View sample

webhook.endpoint.disabledBoundry disabled the endpoint after repeated failures.

webhook

View schema

View sample

webhook.endpoint.deletedA webhook endpoint was removed.

webhook

View schema

View sample

`email.queued`

Boundry accepted the email and queued it.

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":[],"created_at":"2026-08-14T12:00:00.000Z","from":"sender@acme.com","html":"<p>Hello</p>","id":"msg_01j0example","last_event":"queued","message_id":null,"object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"created_at":"2026-08-14T12:00:00.000Z","from":"sender@acme.com","html":"<p>Hello</p>","id":"msg_01j0example","last_event":"queued","message_id":null,"object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}.

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".

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".

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.

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.queued".

Sample body

email.queued event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "created_at": "2026-08-14T12:00:00.000Z",
      "from": "sender@acme.com",
      "html": "<p>Hello</p>",
      "id": "msg_01j0example",
      "last_event": "queued",
      "message_id": null,
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.queued"
}

`email.scheduled`

The email is held for a future send time.

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","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"scheduled","message_id":null,"object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":"2026-08-15T12:00:00.000Z","subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"scheduled","message_id":null,"object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":"2026-08-15T12:00:00.000Z","subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}.

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".

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

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_atrequiredstring (date-time)

Scheduled send time. Example: "2026-08-14T12:00:00.000Z".

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.

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.scheduled".

Sample body

email.scheduled 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",
      "from": "sender@acme.com",
      "html": null,
      "id": "msg_01j0example",
      "last_event": "scheduled",
      "message_id": null,
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": "2026-08-15T12:00:00.000Z",
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.scheduled"
}

`email.sending`

Handed to the regional transport.

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

objectrequiredobject

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".

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

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.

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.sending".

Sample body

email.sending event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "created_at": "2026-08-14T12:00:00.000Z",
      "from": "sender@acme.com",
      "html": "<p>Hello</p>",
      "id": "msg_01j0example",
      "last_event": "queued",
      "message_id": null,
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.sending"
}

`email.sent`

Accepted for delivery by the transport.

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

objectrequiredobject

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".

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

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.

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.sent".

Sample body

email.sent event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "created_at": "2026-08-14T12:00:00.000Z",
      "from": "sender@acme.com",
      "html": "<p>Hello</p>",
      "id": "msg_01j0example",
      "last_event": "queued",
      "message_id": null,
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.sent"
}

`email.delivered`

The recipient server accepted the message.

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","delivered_at":"2026-08-14T12:01:00.000Z","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"delivered","message_id":"<010001@example>","object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"smtp_response":"250 2.0.0 OK","subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","delivered_at":"2026-08-14T12:01:00.000Z","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"delivered","message_id":"<010001@example>","object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"smtp_response":"250 2.0.0 OK","subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}.

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".

delivered_atrequiredstring (date-time)

Timestamp reported by the recipient transport. 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

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".

remote_mta_ipstring

Recipient mail-transfer-agent IP address.

reply_torequiredarray

Reply-to addresses.

scheduled_atrequirednull | null

Scheduled delivery time; local mode does not schedule emails.

smtp_responsestring

Recipient SMTP response. Example: "250 2.0.0 OK".

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.

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.delivered".

Sample body

email.delivered 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",
      "delivered_at": "2026-08-14T12:01:00.000Z",
      "from": "sender@acme.com",
      "html": null,
      "id": "msg_01j0example",
      "last_event": "delivered",
      "message_id": "<010001@example>",
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "smtp_response": "250 2.0.0 OK",
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.delivered"
}

`email.delivery_delayed`

A recipient server deferred the message; retries continue.

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","delay_reason":"Mailbox is temporarily unavailable.","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"delivery_delayed","message_id":"<010001@example>","next_retry_at":"2026-08-14T12:06:00.000Z","object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","delay_reason":"Mailbox is temporarily unavailable.","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"delivery_delayed","message_id":"<010001@example>","next_retry_at":"2026-08-14T12:06:00.000Z","object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}.

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".

delay_reasonrequiredstring

Recipient server deferral reason. Example: "Mailbox is temporarily unavailable.".

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

message_idrequiredstring | null | null

Provider message identifier, or null before delivery.

Option 1string

Provider message identifier.

Option 2null | null

One permitted response shape.

next_retry_atrequiredstring (date-time)

Next planned delivery attempt. Example: "2026-08-14T12:00:00.000Z".

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.

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.delivery_delayed".

Sample body

email.delivery_delayed 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",
      "delay_reason": "Mailbox is temporarily unavailable.",
      "from": "sender@acme.com",
      "html": null,
      "id": "msg_01j0example",
      "last_event": "delivery_delayed",
      "message_id": "<010001@example>",
      "next_retry_at": "2026-08-14T12:06:00.000Z",
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.delivery_delayed"
}

`email.bounced`

Permanently rejected.

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":[],"bounce_subtype":"NoEmail","bounce_type":"Permanent","cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","diagnostic_code":"smtp; 550 5.1.1 user unknown","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"bounced","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"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"bounce_subtype":"NoEmail","bounce_type":"Permanent","cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","diagnostic_code":"smtp; 550 5.1.1 user unknown","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"bounced","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"]}.

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.

bounce_subtyperequiredstring

SES bounce subtype. Values: "Undetermined", "General", "NoEmail", "Suppressed", "OnAccountSuppressionList", "MailboxFull", "MessageTooLarge", "ContentRejected", "AttachmentRejected".

bounce_typerequiredstring

SES bounce type. Values: "Undetermined", "Transient", "Permanent".

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".

diagnostic_coderequiredstring | null | null

Recipient diagnostic code, or null when SES did not report one.

Option 1string

Recipient diagnostic code reported by SES.

Option 2null | null

One permitted response shape.

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

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.

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.bounced".

Sample body

email.bounced event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "bounce_subtype": "NoEmail",
      "bounce_type": "Permanent",
      "cc": [],
      "channel": "email",
      "created_at": "2026-08-14T12:00:00.000Z",
      "diagnostic_code": "smtp; 550 5.1.1 user unknown",
      "from": "sender@acme.com",
      "html": null,
      "id": "msg_01j0example",
      "last_event": "bounced",
      "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"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.bounced"
}

`email.complained`

The recipient marked the message as spam.

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","complaint_feedback_type":"abuse","created_at":"2026-08-14T12:00:00.000Z","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"complained","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"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"channel":"email","complaint_feedback_type":"abuse","created_at":"2026-08-14T12:00:00.000Z","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"complained","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"]}.

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".

complaint_feedback_typerequiredstring | null | null

SES complaint feedback type, or null when absent.

Option 1string

One permitted response shape.

Option 2null | null

One permitted response shape.

created_atrequiredstring (date-time)

Timestamp when Boundry accepted the message. 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

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.

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.complained".

Sample body

email.complained event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "channel": "email",
      "complaint_feedback_type": "abuse",
      "created_at": "2026-08-14T12:00:00.000Z",
      "from": "sender@acme.com",
      "html": null,
      "id": "msg_01j0example",
      "last_event": "complained",
      "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"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.complained"
}

`email.opened`

A tracking pixel was loaded.

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":"opened","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"]}}.

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":"opened","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"]}.

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

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.

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.opened".

Sample body

email.opened 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": "opened",
      "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"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.opened"
}

`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

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"
}

`email.failed`

Boundry could not send the message.

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","failure_reason":"Sender identity is not verified.","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"failed","message_id":null,"object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"channel":"email","created_at":"2026-08-14T12:00:00.000Z","failure_reason":"Sender identity is not verified.","from":"sender@acme.com","html":null,"id":"msg_01j0example","last_event":"failed","message_id":null,"object":"email","project_id":"proj_au_prod","reply_to":[],"scheduled_at":null,"subject":"Welcome","tags":[],"text":"Hello","to":["hello@example.com"]}.

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".

failure_reasonrequiredstring

Reason Boundry could not send the email. Example: "Sender identity is not verified.".

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

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.

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.failed".

Sample body

email.failed 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",
      "failure_reason": "Sender identity is not verified.",
      "from": "sender@acme.com",
      "html": null,
      "id": "msg_01j0example",
      "last_event": "failed",
      "message_id": null,
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.failed"
}

`email.canceled`

A scheduled email was cancelled before sending.

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

objectrequiredobject

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".

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

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.

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.canceled".

Sample body

email.canceled event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "created_at": "2026-08-14T12:00:00.000Z",
      "from": "sender@acme.com",
      "html": "<p>Hello</p>",
      "id": "msg_01j0example",
      "last_event": "queued",
      "message_id": null,
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "scheduled_at": null,
      "subject": "Welcome",
      "tags": [],
      "text": "Hello",
      "to": [
        "hello@example.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.canceled"
}

`email.received`

Inbound mail was accepted for a receiving domain.

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":[],"created_at":"2026-08-14T12:00:00.000Z","from":"sender@example.com","html":null,"id":"rcv_01j0example","last_event":"received","object":"email","project_id":"proj_au_prod","reply_to":[],"subject":"Hello","tags":[],"text":"Hello","to":["inbox@acme.com"]}}.

objectrequiredobject

Event resource. Example: {"attachments":[],"bcc":[],"cc":[],"created_at":"2026-08-14T12:00:00.000Z","from":"sender@example.com","html":null,"id":"rcv_01j0example","last_event":"received","object":"email","project_id":"proj_au_prod","reply_to":[],"subject":"Hello","tags":[],"text":"Hello","to":["inbox@acme.com"]}.

attachmentsrequiredarray

Inbound attachment metadata; unsupported in local mode.

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".

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

Inbound lifecycle event. Values: "received", "stored".

objectrequiredstring

Resource type discriminator. Values: "email".

project_idrequiredstring

Owning project identifier. Example: "msg_01j0example".

reply_torequiredarray

Reply-to addresses.

subjectrequiredstring

Email subject.

tagsrequiredarray

Message 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

Receiving addresses.

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.received".

Sample body

email.received event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "created_at": "2026-08-14T12:00:00.000Z",
      "from": "sender@example.com",
      "html": null,
      "id": "rcv_01j0example",
      "last_event": "received",
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "subject": "Hello",
      "tags": [],
      "text": "Hello",
      "to": [
        "inbox@acme.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.received"
}

`email.stored`

Inbound mail was persisted in the regional data plane.

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

objectrequiredobject

attachmentsrequiredarray

Inbound attachment metadata; unsupported in local mode.

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".

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

Inbound lifecycle event. Values: "received", "stored".

objectrequiredstring

Resource type discriminator. Values: "email".

project_idrequiredstring

Owning project identifier. Example: "msg_01j0example".

reply_torequiredarray

Reply-to addresses.

subjectrequiredstring

Email subject.

tagsrequiredarray

Message 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

Receiving addresses.

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.stored".

Sample body

email.stored event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "attachments": [],
      "bcc": [],
      "cc": [],
      "created_at": "2026-08-14T12:00:00.000Z",
      "from": "sender@example.com",
      "html": null,
      "id": "rcv_01j0example",
      "last_event": "received",
      "object": "email",
      "project_id": "proj_au_prod",
      "reply_to": [],
      "subject": "Hello",
      "tags": [],
      "text": "Hello",
      "to": [
        "inbox@acme.com"
      ]
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "email.stored"
}

`domain.created`

A domain was attached to the project.

Channel: domain

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":{"capabilities":{"receiving":"disabled","sending":"enabled"},"click_tracking":false,"created_at":"2026-08-14T12:00:00.000Z","id":"dom_01j0example","name":"acme.com","object":"domain","open_tracking":false,"records":[],"region":"ap-southeast-2","status":"not_started","tracking_subdomain":"links"}}.

objectrequiredobject

Event resource. Example: {"capabilities":{"receiving":"disabled","sending":"enabled"},"click_tracking":false,"created_at":"2026-08-14T12:00:00.000Z","id":"dom_01j0example","name":"acme.com","object":"domain","open_tracking":false,"records":[],"region":"ap-southeast-2","status":"not_started","tracking_subdomain":"links"}.

capabilitiesrequiredobject

Domain capabilities.

receivingrequiredstring

Receiving capability. Values: "enabled", "disabled".

sendingrequiredstring

Sending capability. Values: "enabled", "disabled".

click_trackingrequiredboolean

Whether click tracking is enabled.

created_atrequiredstring (date-time)

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

idrequiredstring

Domain identifier. Example: "msg_01j0example".

namerequiredstring

Registered domain or subdomain. Example: "acme.com".

objectrequiredstring

Resource type discriminator. Values: "domain".

open_trackingrequiredboolean

Whether open tracking is enabled.

recordsrequiredarray

Required DNS records.

namerequiredstring

DNS record name. Example: "acme.com".

priorityinteger

MX priority when applicable.

recordrequiredstring

DNS record purpose. Values: "DKIM", "SPF", "MX", "Tracking".

statusrequiredstring

Verification status. Values: "verified", "not_started".

ttlrequiredstring

DNS time-to-live value. Example: "Auto".

typerequiredstring

DNS record type. Values: "TXT", "MX", "CNAME".

valuerequiredstring

DNS record value.

regionrequiredstring

Owning Boundry region. Values: "ap-southeast-2".

statusrequiredstring

Domain verification status. Values: "verified", "not_started".

tracking_subdomainrequiredstring

Tracking subdomain label. Example: "links".

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: "domain.created".

Sample body

domain.created event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "capabilities": {
        "receiving": "disabled",
        "sending": "enabled"
      },
      "click_tracking": false,
      "created_at": "2026-08-14T12:00:00.000Z",
      "id": "dom_01j0example",
      "name": "acme.com",
      "object": "domain",
      "open_tracking": false,
      "records": [],
      "region": "ap-southeast-2",
      "status": "not_started",
      "tracking_subdomain": "links"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "domain.created"
}

`domain.verified`

All required DNS records were observed.

Channel: domain

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

objectrequiredobject

capabilitiesrequiredobject

Domain capabilities.

receivingrequiredstring

Receiving capability. Values: "enabled", "disabled".

sendingrequiredstring

Sending capability. Values: "enabled", "disabled".

click_trackingrequiredboolean

Whether click tracking is enabled.

created_atrequiredstring (date-time)

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

idrequiredstring

Domain identifier. Example: "msg_01j0example".

namerequiredstring

Registered domain or subdomain. Example: "acme.com".

objectrequiredstring

Resource type discriminator. Values: "domain".

open_trackingrequiredboolean

Whether open tracking is enabled.

recordsrequiredarray

Required DNS records.

namerequiredstring

DNS record name. Example: "acme.com".

priorityinteger

MX priority when applicable.

recordrequiredstring

DNS record purpose. Values: "DKIM", "SPF", "MX", "Tracking".

statusrequiredstring

Verification status. Values: "verified", "not_started".

ttlrequiredstring

DNS time-to-live value. Example: "Auto".

typerequiredstring

DNS record type. Values: "TXT", "MX", "CNAME".

valuerequiredstring

DNS record value.

regionrequiredstring

Owning Boundry region. Values: "ap-southeast-2".

statusrequiredstring

Domain verification status. Values: "verified", "not_started".

tracking_subdomainrequiredstring

Tracking subdomain label. Example: "links".

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: "domain.verified".

Sample body

domain.verified event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "capabilities": {
        "receiving": "disabled",
        "sending": "enabled"
      },
      "click_tracking": false,
      "created_at": "2026-08-14T12:00:00.000Z",
      "id": "dom_01j0example",
      "name": "acme.com",
      "object": "domain",
      "open_tracking": false,
      "records": [],
      "region": "ap-southeast-2",
      "status": "not_started",
      "tracking_subdomain": "links"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "domain.verified"
}

`domain.verification_failed`

DNS verification did not pass.

Channel: domain

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

objectrequiredobject

capabilitiesrequiredobject

Domain capabilities.

receivingrequiredstring

Receiving capability. Values: "enabled", "disabled".

sendingrequiredstring

Sending capability. Values: "enabled", "disabled".

click_trackingrequiredboolean

Whether click tracking is enabled.

created_atrequiredstring (date-time)

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

idrequiredstring

Domain identifier. Example: "msg_01j0example".

namerequiredstring

Registered domain or subdomain. Example: "acme.com".

objectrequiredstring

Resource type discriminator. Values: "domain".

open_trackingrequiredboolean

Whether open tracking is enabled.

recordsrequiredarray

Required DNS records.

namerequiredstring

DNS record name. Example: "acme.com".

priorityinteger

MX priority when applicable.

recordrequiredstring

DNS record purpose. Values: "DKIM", "SPF", "MX", "Tracking".

statusrequiredstring

Verification status. Values: "verified", "not_started".

ttlrequiredstring

DNS time-to-live value. Example: "Auto".

typerequiredstring

DNS record type. Values: "TXT", "MX", "CNAME".

valuerequiredstring

DNS record value.

regionrequiredstring

Owning Boundry region. Values: "ap-southeast-2".

statusrequiredstring

Domain verification status. Values: "verified", "not_started".

tracking_subdomainrequiredstring

Tracking subdomain label. Example: "links".

verification_errorrequiredstring

DNS verification failure reason. Example: "Required DKIM record was not found.".

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: "domain.verification_failed".

Sample body

domain.verification_failed event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "capabilities": {
        "receiving": "disabled",
        "sending": "enabled"
      },
      "click_tracking": false,
      "created_at": "2026-08-14T12:00:00.000Z",
      "id": "dom_01j0example",
      "name": "acme.com",
      "object": "domain",
      "open_tracking": false,
      "records": [],
      "region": "ap-southeast-2",
      "status": "not_started",
      "tracking_subdomain": "links",
      "verification_error": "Required DKIM record was not found."
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "domain.verification_failed"
}

`domain.updated`

Domain capabilities or tracking changed.

Channel: domain

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

objectrequiredobject

capabilitiesrequiredobject

Domain capabilities.

receivingrequiredstring

Receiving capability. Values: "enabled", "disabled".

sendingrequiredstring

Sending capability. Values: "enabled", "disabled".

click_trackingrequiredboolean

Whether click tracking is enabled.

created_atrequiredstring (date-time)

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

idrequiredstring

Domain identifier. Example: "msg_01j0example".

namerequiredstring

Registered domain or subdomain. Example: "acme.com".

objectrequiredstring

Resource type discriminator. Values: "domain".

open_trackingrequiredboolean

Whether open tracking is enabled.

recordsrequiredarray

Required DNS records.

namerequiredstring

DNS record name. Example: "acme.com".

priorityinteger

MX priority when applicable.

recordrequiredstring

DNS record purpose. Values: "DKIM", "SPF", "MX", "Tracking".

statusrequiredstring

Verification status. Values: "verified", "not_started".

ttlrequiredstring

DNS time-to-live value. Example: "Auto".

typerequiredstring

DNS record type. Values: "TXT", "MX", "CNAME".

valuerequiredstring

DNS record value.

regionrequiredstring

Owning Boundry region. Values: "ap-southeast-2".

statusrequiredstring

Domain verification status. Values: "verified", "not_started".

tracking_subdomainrequiredstring

Tracking subdomain label. Example: "links".

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: "domain.updated".

Sample body

domain.updated event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "capabilities": {
        "receiving": "disabled",
        "sending": "enabled"
      },
      "click_tracking": false,
      "created_at": "2026-08-14T12:00:00.000Z",
      "id": "dom_01j0example",
      "name": "acme.com",
      "object": "domain",
      "open_tracking": false,
      "records": [],
      "region": "ap-southeast-2",
      "status": "not_started",
      "tracking_subdomain": "links"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "domain.updated"
}

`domain.deleted`

A domain was detached from the project.

Channel: domain

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":{"deleted":true,"id":"dom_01j0example","object":"domain"}}.

objectrequiredobject

Event resource. Example: {"deleted":true,"id":"dom_01j0example","object":"domain"}.

deletedrequiredboolean

Deletion marker. Values: true.

idrequiredstring

Deleted domain identifier. Example: "msg_01j0example".

objectrequiredstring

Resource type discriminator. Values: "domain".

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: "domain.deleted".

Sample body

domain.deleted event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "deleted": true,
      "id": "dom_01j0example",
      "object": "domain"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "domain.deleted"
}

`api_key.created`

A project API key was issued.

Channel: api_key

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":{"created_at":"2026-08-14T12:00:00.000Z","id":"key_01j0example","name":"Production app"}}.

objectrequiredobject

Event resource. Example: {"created_at":"2026-08-14T12:00:00.000Z","id":"key_01j0example","name":"Production app"}.

created_atrequiredstring (date-time)

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

idrequiredstring

API key identifier. Example: "msg_01j0example".

namerequiredstring

Human-readable API key name. Example: "Production app".

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: "api_key.created".

Sample body

api_key.created event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "created_at": "2026-08-14T12:00:00.000Z",
      "id": "key_01j0example",
      "name": "Production app"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "api_key.created"
}

`api_key.revoked`

A project API key was revoked.

Channel: api_key

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":{"created_at":"2026-08-14T12:00:00.000Z","id":"key_01j0example","name":"Production app"}}.

objectrequiredobject

Event resource. Example: {"created_at":"2026-08-14T12:00:00.000Z","id":"key_01j0example","name":"Production app"}.

created_atrequiredstring (date-time)

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

idrequiredstring

API key identifier. Example: "msg_01j0example".

namerequiredstring

Human-readable API key name. Example: "Production app".

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: "api_key.revoked".

Sample body

api_key.revoked event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "created_at": "2026-08-14T12:00:00.000Z",
      "id": "key_01j0example",
      "name": "Production app"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "api_key.revoked"
}

`webhook.endpoint.created`

A webhook endpoint was created.

Channel: webhook

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":{"api_version":"2026-08-14","consecutive_failures":0,"created_at":"2026-08-14T12:00:00.000Z","description":null,"endpoint":"https://hooks.acme.com/boundry","events":["email.sent"],"id":"wh_01j0example","last_failure_at":null,"last_success_at":null,"object":"webhook","secret_prefix":"whsec_example","status":"enabled","updated_at":"2026-08-14T12:00:00.000Z"}}.

objectrequiredobject

Event resource. Example: {"api_version":"2026-08-14","consecutive_failures":0,"created_at":"2026-08-14T12:00:00.000Z","description":null,"endpoint":"https://hooks.acme.com/boundry","events":["email.sent"],"id":"wh_01j0example","last_failure_at":null,"last_success_at":null,"object":"webhook","secret_prefix":"whsec_example","status":"enabled","updated_at":"2026-08-14T12:00:00.000Z"}.

api_versionrequiredstring

API version pinned to this endpoint. Values: "2026-08-14".

consecutive_failuresrequiredinteger

Consecutive delivery failures.

created_atrequiredstring (date-time)

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

descriptionrequiredstring | null | null

Optional endpoint description.

Option 1string

Optional endpoint description.

Option 2null | null

One permitted response shape.

endpointrequiredstring (uri)

Webhook delivery endpoint URL. Example: "https://hooks.acme.com/boundry".

eventsrequiredarray

Subscribed event types.

idrequiredstring

Webhook identifier. Example: "msg_01j0example".

last_failure_atrequiredstring (date-time) | null | null

Timestamp of the last failed delivery, or null.

Option 1string (date-time)

Timestamp of the last failed delivery.

Option 2null | null

One permitted response shape.

last_success_atrequiredstring (date-time) | null | null

Timestamp of the last successful delivery, or null.

Option 1string (date-time)

Timestamp of the last successful delivery.

Option 2null | null

One permitted response shape.

objectrequiredstring

Resource type discriminator. Values: "webhook".

secret_prefixrequiredstring

Non-secret signing-secret prefix. Example: "whsec_example".

statusrequiredstring

Webhook state. Values: "enabled", "disabled", "pending".

updated_atrequiredstring (date-time)

Timestamp when the webhook was last updated. Example: "2026-08-14T12:00:00.000Z".

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: "webhook.endpoint.created".

Sample body

webhook.endpoint.created event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "api_version": "2026-08-14",
      "consecutive_failures": 0,
      "created_at": "2026-08-14T12:00:00.000Z",
      "description": null,
      "endpoint": "https://hooks.acme.com/boundry",
      "events": [
        "email.sent"
      ],
      "id": "wh_01j0example",
      "last_failure_at": null,
      "last_success_at": null,
      "object": "webhook",
      "secret_prefix": "whsec_example",
      "status": "enabled",
      "updated_at": "2026-08-14T12:00:00.000Z"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "webhook.endpoint.created"
}

`webhook.endpoint.updated`

A webhook endpoint changed.

Channel: webhook

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

objectrequiredobject

api_versionrequiredstring

API version pinned to this endpoint. Values: "2026-08-14".

consecutive_failuresrequiredinteger

Consecutive delivery failures.

created_atrequiredstring (date-time)

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

descriptionrequiredstring | null | null

Optional endpoint description.

Option 1string

Optional endpoint description.

Option 2null | null

One permitted response shape.

endpointrequiredstring (uri)

Webhook delivery endpoint URL. Example: "https://hooks.acme.com/boundry".

eventsrequiredarray

Subscribed event types.

idrequiredstring

Webhook identifier. Example: "msg_01j0example".

last_failure_atrequiredstring (date-time) | null | null

Timestamp of the last failed delivery, or null.

Option 1string (date-time)

Timestamp of the last failed delivery.

Option 2null | null

One permitted response shape.

last_success_atrequiredstring (date-time) | null | null

Timestamp of the last successful delivery, or null.

Option 1string (date-time)

Timestamp of the last successful delivery.

Option 2null | null

One permitted response shape.

objectrequiredstring

Resource type discriminator. Values: "webhook".

secret_prefixrequiredstring

Non-secret signing-secret prefix. Example: "whsec_example".

statusrequiredstring

Webhook state. Values: "enabled", "disabled", "pending".

updated_atrequiredstring (date-time)

Timestamp when the webhook was last updated. Example: "2026-08-14T12:00:00.000Z".

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: "webhook.endpoint.updated".

Sample body

webhook.endpoint.updated event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "api_version": "2026-08-14",
      "consecutive_failures": 0,
      "created_at": "2026-08-14T12:00:00.000Z",
      "description": null,
      "endpoint": "https://hooks.acme.com/boundry",
      "events": [
        "email.sent"
      ],
      "id": "wh_01j0example",
      "last_failure_at": null,
      "last_success_at": null,
      "object": "webhook",
      "secret_prefix": "whsec_example",
      "status": "enabled",
      "updated_at": "2026-08-14T12:00:00.000Z"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "webhook.endpoint.updated"
}

`webhook.endpoint.disabled`

Boundry disabled the endpoint after repeated failures.

Channel: webhook

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":{"created_at":"2026-08-14T12:00:00.000Z","disable_reason":"20 consecutive failed deliveries.","disabled_at":"2026-08-15T12:00:00.000Z","endpoint":"https://example.com/webhooks/boundry","events":["email.sent"],"id":"wh_01j0example","object":"webhook","status":"disabled"}}.

objectrequiredobject

Event resource. Example: {"created_at":"2026-08-14T12:00:00.000Z","disable_reason":"20 consecutive failed deliveries.","disabled_at":"2026-08-15T12:00:00.000Z","endpoint":"https://example.com/webhooks/boundry","events":["email.sent"],"id":"wh_01j0example","object":"webhook","status":"disabled"}.

api_versionrequiredstring

API version pinned to this endpoint. Values: "2026-08-14".

consecutive_failuresrequiredinteger

Consecutive delivery failures.

created_atrequiredstring (date-time)

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

descriptionrequiredstring | null | null

Optional endpoint description.

Option 1string

Optional endpoint description.

Option 2null | null

One permitted response shape.

disable_reasonrequiredstring

Reason the endpoint was disabled. Example: "20 consecutive failed deliveries.".

disabled_atrequiredstring (date-time)

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

endpointrequiredstring (uri)

Webhook delivery endpoint URL. Example: "https://hooks.acme.com/boundry".

eventsrequiredarray

Subscribed event types.

idrequiredstring

Webhook identifier. Example: "msg_01j0example".

last_failure_atrequiredstring (date-time) | null | null

Timestamp of the last failed delivery, or null.

Option 1string (date-time)

Timestamp of the last failed delivery.

Option 2null | null

One permitted response shape.

last_success_atrequiredstring (date-time) | null | null

Timestamp of the last successful delivery, or null.

Option 1string (date-time)

Timestamp of the last successful delivery.

Option 2null | null

One permitted response shape.

objectrequiredstring

Resource type discriminator. Values: "webhook".

secret_prefixrequiredstring

Non-secret signing-secret prefix. Example: "whsec_example".

statusrequiredstring

Webhook state. Values: "disabled".

updated_atrequiredstring (date-time)

Timestamp when the webhook was last updated. Example: "2026-08-14T12:00:00.000Z".

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: "webhook.endpoint.disabled".

Sample body

webhook.endpoint.disabled event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "created_at": "2026-08-14T12:00:00.000Z",
      "disable_reason": "20 consecutive failed deliveries.",
      "disabled_at": "2026-08-15T12:00:00.000Z",
      "endpoint": "https://example.com/webhooks/boundry",
      "events": [
        "email.sent"
      ],
      "id": "wh_01j0example",
      "object": "webhook",
      "status": "disabled"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "webhook.endpoint.disabled"
}

`webhook.endpoint.deleted`

A webhook endpoint was removed.

Channel: webhook

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":{"deleted":true,"id":"wh_01j0example","object":"webhook"}}.

objectrequiredobject

Event resource. Example: {"deleted":true,"id":"wh_01j0example","object":"webhook"}.

deletedrequiredboolean

Deletion marker. Values: true.

idrequiredstring

Deleted webhook identifier. Example: "msg_01j0example".

objectrequiredstring

Resource type discriminator. Values: "webhook".

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: "webhook.endpoint.deleted".

Sample body

webhook.endpoint.deleted event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "deleted": true,
      "id": "wh_01j0example",
      "object": "webhook"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "webhook.endpoint.deleted"
}