Skip to main content

listing.updated

Listing metadata mutation (address, agents, selected propertyData sub-fields)

Category: Listing Lifecycle

Emitted when: After TourCrudService.update_tour commits a tracked field change

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

FieldTypeDescription
event_idstringULID; globally unique. Safe to persist as the dedup key.
event_typestringAlways listing.updated for this event.
api_versionstringPayload schema version (YYYY-MM-DD).
timestampintegerUnix epoch seconds at dispatch time.
noncestringULID; unique per delivery, used for replay rejection.
dataobjectEvent-specific payload (see below).

Delivery also sets three HTTP headers on the inbound POST:

HeaderMeaning
X-Webhook-Event-IdMirrors event_id; cheaper than parsing the body to dedup.
X-Webhook-TimestampMirrors timestamp for replay-window checks.
X-Webhook-Signaturesha256=<hex> HMAC over timestamp.body.

Data schema

FieldTypeRequiredDescription
agency_idstringyesBetter Auth id of the media_agency that owns the listing.
listing_numberstringyesPublic listing number, 7-char lowercase nanoid ([a-z0-9]{7}).
changed_bystringyesActor token: 'apikey:' for API calls, 'user:' for dashboard.
changesobjectyesDotted-path delta map. Keys come from the tracked allowlist declared in this module (_TRACKED_TOP_LEVEL + _TRACKED_PROPERTY_DATA). An empty dict is never emitted - the emitter guards on that.

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_4HVGMBFKYZ6D7ETQ43T30RNRQ2",
"event_type": "listing.updated",
"api_version": "2026-04-17",
"timestamp": 1745339401,
"nonce": "5T6JYV65WQN356K4XSQMD277XJ",
"data": {
"agency_id": "user_01HXAGENCY0000000000000",
"listing_number": "abc1234",
"changed_by": "apikey:key_01HXAPIKEY000000000000",
"changes": {}
}
}

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

sha256=4f35d1f6e790fd669a03753a27e8e3bb0a1cb152254e76c307721a12d080dd48

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.