Documentation/domain.updated

`domain.updated`

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

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

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

Verify signed webhook deliveries →