listing.status_changed

A listing's status transitioned (e.g. Active -> Sold)

Category: Listing Lifecycle

Emitted when: After TourStatusService.update_status() commits a non-noop transition

Envelope

Every delivery wraps the event-specific data block in the canonical envelope documented on the webhook overview page. The body carries SIX keys; the HMAC signature is delivered as the X-Webhook-Signature request header on the inbound POST to your endpoint (NOT as a body field; including it in the body would make the HMAC a function of its own output).

Field	Type	Description
event_id	string	ULID; globally unique. Safe to persist as the dedup key.
event_type	string	Always listing.status_changed for this event.
api_version	string	Payload schema version (YYYY-MM-DD).
timestamp	integer	Unix epoch seconds at dispatch time.
nonce	string	ULID; unique per delivery, used for replay rejection.
data	object	Event-specific payload (see below).

Delivery also sets three HTTP headers on the inbound POST:

Header	Meaning
X-Webhook-Event-Id	Mirrors event_id; cheaper than parsing the body to dedup.
X-Webhook-Timestamp	Mirrors timestamp for replay-window checks.
X-Webhook-Signature	sha256=<hex> HMAC over timestamp.body.

Data schema

Field	Type	Required	Description
agency_id	string	yes	Agency Id
listing_number	string	yes	Public listing number, 7-char lowercase nanoid ([a-z0-9]{7})
old_status	"Coming Soon" | "Active" | "Pending" | "Sold" | "Archived"	yes	Old Status
new_status	"Coming Soon" | "Active" | "Pending" | "Sold" | "Archived"	yes	New Status
changed_by	string	yes	Actor token: 'apikey:' for API calls, 'user:' for dashboard
source	"dashboard" | "api" | "system"	yes	Source
side_effects	object	yes	Machine-readable consequences of a status transition. Locked contract field set: image_variants_unlocked and public_url_indexable. Adding a field here means bumping the event version; receivers must be coordinated. Fields ------ image_variants_unlocked: list[str] Variant names that just became accessible to agents / assistants / viewers. Always a list (possibly empty). Fixed set today: ["print_ready", "mls_ready"] or []. public_url_indexable: bool True iff the property is publicly visible AND safe for search engines to index. Only "Active" satisfies both conditions.

Sample payload

The sample below is a live fixture. Feed the exact body bytes shown plus the timestamp into the HMAC-SHA256 recipe from the webhook overview using the documented test-vector secret (test_secret_001 ) and you will recover the signature header value printed below.

Body (delivered as the HTTP request body):

{
  "event_id": "evt_2QGF4T2D1FQ62D3J99V75B3089",
  "event_type": "listing.status_changed",
  "api_version": "2026-04-17",
  "timestamp": 1745339401,
  "nonce": "09DFP7SSHXFKDJJ7Y3FJ58TFN9",
  "data": {
    "agency_id": "user_01HXAGENCY0000000000000",
    "listing_number": "abc1234",
    "old_status": "Coming Soon",
    "new_status": "Active",
    "changed_by": "apikey:key_01HXAPIKEY000000000000",
    "source": "dashboard",
    "side_effects": {
      "image_variants_unlocked": [
        "hero",
        "gallery",
        "floorplan"
      ],
      "public_url_indexable": true
    }
  }
}

Signature header (delivered as X-Webhook-Signature on the same request):

sha256=771a8cf80059b6720c79f93378e94b439b7cca02add1efae1267d3875e6fb8a7

Retry behaviour

Failed deliveries retry on the sequence 2, 4, 8, 16, 32 seconds (five attempts plus the initial call for a total of six over approximately 62 seconds of wall clock). After the final attempt the delivery lands in the dead-letter queue and the dashboard operator can replay it from Settings > API Keys > Webhook Endpoint > Deliveries. See the webhook overview for the full rules.

Verification

Every receiver MUST verify the X-Webhook-Signature header using the recipe in the webhook overview. Rejecting deliveries whose timestamp is more than 5 minutes off your wall clock (after NTP correction on your side) or whose nonce has already been consumed in the last 10 minutes is part of the contract.