Skip to main content

listing.created

A new listing was created via API or dashboard

Category: Listing Lifecycle

Emitted when: After TourCreateService.create_tour() commits successfully

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.created 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_idstringyesAgency Id
listing_idstringyesHex ObjectId of the Tour document
listing_numberstringyesPublic listing number, 7-char lowercase nanoid ([a-z0-9]{7})
addressstringyesAddress
owner_user_idstringyesOwner User Id
agent_one_idstring | nullyesAgent One Id
agent_two_idstring | nullyesAgent Two Id
status"Coming Soon" | "Active" | "Pending" | "Sold" | "Archived"yesStatus
is_activatedbooleanyesIs Activated
created_bystringyesActor token: 'apikey:' for API calls, 'user:' for dashboard
public_urlstringyesPublic Url

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_4TYN79CPNG58NDH7KZW2AJRBB0",
"event_type": "listing.created",
"api_version": "2026-04-17",
"timestamp": 1745339401,
"nonce": "474EGG70V2R1E36QJGFY5XSS2E",
"data": {
"agency_id": "user_01HXAGENCY0000000000000",
"listing_id": "66312a4b5c6d7e8f90a1b2c3",
"listing_number": "abc1234",
"address": "123 Main St, Portland, OR 97201",
"owner_user_id": "user_01HXAGENCYOWNER00000000",
"agent_one_id": "user_01HXAGENTONE0000000000",
"agent_two_id": "user_01HXAGENTTWO0000000000",
"status": "Coming Soon",
"is_activated": true,
"created_by": "apikey:key_01HXAPIKEY000000000000",
"public_url": "https://example.com/"
}
}

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

sha256=aa2e66adf9a4ca48ff436ea32b3d66969221bb34f2f58827e24332a0162bb66c

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.