website#searchproperties

Message

a website user shares a property listing

a website user has performed a property search

Payload Example(s) (generated)

{
  "topic": "realestate/website#searchproperties",
  "recipient": null,
  "time": "2025-07-29T11:56:56.5008617-05:00",
  "agent": "Constellation 1",
  "instrument": "Trio",
  "source": "https://CA322.dev.bhhs.hsfaffilaites.com/profile/card#me",
  "data": {
    "type": "SearchAction",
    "identifier": "nwurogb34tnoi3t",
    "object": {
      "type": "PropertySearch",
      "name": null,
      "description": null,
      "propertyType": "RINC",
      "propertySubType": {
        "propertySubType": ""
      },
      "listingStatus": "ActiveListingStatuss",
      "location": {
        "type": "City",
        "address": {
          "type": "PostalAddress",
          "streetAddress": "1007 Mountain Gate Rd",
          "addressRegion": "New Jersey",
          "addressLocality": "Gotham City",
          "postalCode": "10010",
          "addressCountry": "USA",
          "addressCounty": "Gotham County",
          "addressSubdivision": "Gotham Heights"
        },
        "geo": {
          "type": "GeoShape",
          "geoMidpoint": {
            "type": "GeoCoordinates",
            "longitude": "73.98",
            "latitude": "40.75"
          },
          "geoRadius": {
            "type": "QuantitativeValue",
            "value": "10",
            "unitCode": "mi",
            "unitText": "miles"
          },
          "box": "(33.5697,-117.775),(33.6018,-117.707)"
        },
        "name": null,
        "addressRegion": "CA",
        "addressLocality": "Long Beach",
        "postalCode": null,
        "addressCountry": "United States",
        "addressCounty": null,
        "box": null,
        "kind": null
      },
      "price": {
        "type": "PriceSpecification",
        "minPrice": null,
        "maxPrice": 610000,
        "price": null,
        "priceCurrency": "USD"
      },
      "bedrooms": {
        "type": "QuantitativeValue",
        "minValue": 2,
        "maxValue": null,
        "unitCode": "BD",
        "unitText": "Bedrooms"
      },
      "bathrooms": {
        "type": "QuantitativeValue",
        "minValue": 2,
        "maxValue": null,
        "unitCode": "BA",
        "unitText": "Bathrooms"
      },
      "livingArea": {
        "type": "QuantitativeValue",
        "minValue": 1000,
        "maxValue": null,
        "unitCode": "SqFt",
        "unitText": "Square Feet"
      },
      "lotSize": {
        "type": "QuantitativeValue",
        "minValue": 0.5,
        "maxValue": null,
        "unitCode": "AC",
        "unitText": "Acres"
      }
    },
    "result": {
      "type": "FindAction",
      "object": [
        {
          "type": "PropertyListing",
          "url": "https://www.dev.bhhs.com/california-properties-ca322/ca/1879-atlantic-avenue-15-long-beach-90806/pid-407822355"
        },
        {
          "type": "PropertyListing",
          "url": "http://example.com/listing/234"
        }
      ]
    },
    "agent": {
      "type": "Contact",
      "name": "Angie P",
      "telephone": "",
      "email": "adilla+bhhs@gmail.com",
      "additionalProperty": {
        "userPath": "xxx"
      },
      "identifier": {
        "sausID": "216bf670-0777-43db-9d73-c3377d280fe4",
        "redContact_Guid": "201ff92c-e3ad-43b1-8a01-5555168cb0ae",
        "hsfConsumerId": "{\"hsfconsumerid\":\"f5f5769c-58fc-4070-840f-b3f06952c5a7\"}"
      },
      "sameAs": {
        "hsfSessionId": "7c0ce637-fd86-48b5-8203-88bvreverv6a266",
        "cregContactKey": "14vrerv64"
      }
    },
    "participant": null,
    "instrument": {
      "type": "RealEstateWebsite",
      "url": "https://dev.bhhs.com/profile/card#me"
    },
    "originatingSystem": {
      "type": "SoftwareApplication",
      "name": "RDesk",
      "description": "User Created.",
      "url": "http://www.rdeskwebsite.com/"
    },
    "event": {
      "type": "Event",
      "name": "Property Showing  64 Buttercup Lane, South Grafton, MA, USA",
      "description": "",
      "subEvents": [
        {
          "type": "Campaign",
          "name": "A good campaign name",
          "id": "ire:1d2995307f2c48ae9543caf586f43f9b",
          "url": "https://www.bhhspro.com/mentor/steve-baird/cid-356481/oh/889-hartford-drive-44035/pid-338005633",
          "contactGroup": [
            {
              "type": "Collection",
              "name": "Topic 1"
            },
            {
              "type": "Collection",
              "name": "Topic 2"
            }
          ]
        }
      ]
    }
  }
}

Payload

NameTypeDescription
(root)object-
topicstringconst ("realestate/website#searchproperties")
recipientstring/nullrecipient
timestringdate and time the event was produced
agentstringevent publisher
instrumentstringevent instrument
sourcestringevent source
dataobjectthe message payload. RANGE: SearchAction
data.typestringconst ("SearchAction")
data.identifierstringunique identifier
data.objectobjectproperty search parameters. RANGE: PropertySearch
data.object.typestringconst ("PropertySearch")
data.object.namestring/nullsearch name
data.object.descriptionstring/nullsearch description
data.object.propertyTypestring/nullproperty type
data.object.propertySubTypeobject/nullproperty subtype details
data.object.propertySubType.propertySubTypestringproperty subtype
data.object.listingStatusstring/nulllisting status
data.object.locationobject/nullsearch location details
data.object.location.typestringlocation type
data.object.location.addressobject/nulladdress details
data.object.location.address.typestringconst ("PostalAddress")
data.object.location.address.streetAddressstringstreet address
data.object.location.address.addressRegionstringstate or region
data.object.location.address.addressLocalitystringcity or locality
data.object.location.address.postalCodestringpostal code
data.object.location.address.addressCountrystringcountry
data.object.location.address.addressCountystringcounty
data.object.location.address.addressSubdivisionstringsubdivision or neighborhood
data.object.location.geoobject/nullgeo details
data.object.location.geo.typestringconst ("GeoShape")
data.object.location.geo.geoMidpointobjectgeo midpoint details
data.object.location.geo.geoMidpoint.typestringconst ("GeoCoordinates")
data.object.location.geo.geoMidpoint.longitudestringlongitude
data.object.location.geo.geoMidpoint.latitudestringlatitude
data.object.location.geo.geoRadiusobjectgeo radius details
data.object.location.geo.geoRadius.typestringconst ("QuantitativeValue")
data.object.location.geo.geoRadius.valuestringradius value
data.object.location.geo.geoRadius.unitCodestringunit code
data.object.location.geo.geoRadius.unitTextstringunit text
data.object.location.geo.boxstringgeo bounding box
data.object.location.namestring/nulllocation name
data.object.location.addressRegionstringstate or region
data.object.location.addressLocalitystringcity or locality
data.object.location.postalCodestring/nullpostal code
data.object.location.addressCountrystringcountry
data.object.location.addressCountystring/nullcounty
data.object.location.boxstring/nullbounding box
data.object.location.kindstring/nulllocation kind
data.object.priceobjectprice criteria
data.object.price.typestringconst ("PriceSpecification")
data.object.price.minPricenumber/nullminimum price
data.object.price.maxPricenumber/nullmaximum price
data.object.price.pricenumber/nullprice
data.object.price.priceCurrencystringuse ISO4217
data.object.bedroomsobject/nullbedroom criteria
data.object.bedrooms.typestringconst ("QuantitativeValue")
data.object.bedrooms.minValuenumber/nullminimum bedrooms
data.object.bedrooms.maxValuenumber/nullmaximum bedrooms
data.object.bedrooms.unitCodestringunit code
data.object.bedrooms.unitTextstringunit text
data.object.bathroomsobject/nullbathroom criteria
data.object.bathrooms.typestringconst ("QuantitativeValue")
data.object.bathrooms.minValuenumber/nullminimum bathrooms
data.object.bathrooms.maxValuenumber/nullmaximum bathrooms
data.object.bathrooms.unitCodestringunit code
data.object.bathrooms.unitTextstringunit text
data.object.livingAreaobject/nullliving area criteria
data.object.livingArea.typestringconst ("QuantitativeValue")
data.object.livingArea.minValuenumber/nullminimum living area
data.object.livingArea.maxValuenumber/nullmaximum living area
data.object.livingArea.unitCodestringunit code
data.object.livingArea.unitTextstringunit text
data.object.lotSizeobject/nulllot size criteria
data.object.lotSize.typestringconst ("QuantitativeValue")
data.object.lotSize.minValuenumber/nullminimum lot size
data.object.lotSize.maxValuenumber/nullmaximum lot size
data.object.lotSize.unitCodestringunit code
data.object.lotSize.unitTextstringunit text
data.resultobject/nullthe result of a search action. RANGE: FindAction
data.result.typestringconst ("FindAction")
data.result.objectarrayresult property listings
data.result.object.0.typestringconst ("PropertyListing")
data.result.object.0.urlstringproperty listing URL
data.agentobjectthe user who performed the search. RANGE: Contact, Person
data.agent.typestringallowed ("Person", "Contact")
data.agent.namestring/nullagent name
data.agent.telephonestring/nulltelephone
data.agent.emailstring/nullformat (email)
data.agent.additionalPropertyobject/nulladditional property
data.agent.additionalProperty.userPathstringuser path
data.agent.identifierobject/nullagent identifier
data.agent.identifier.sausIDstringSAUS identifier
data.agent.identifier.redContact_GuidstringRED contact GUID
data.agent.identifier.hsfConsumerIdstringHSF consumer ID
data.agent.sameAsobjectsameAs identifiers
data.agent.sameAs.hsfSessionIdstringHSF session ID
data.agent.sameAs.cregContactKeystring/nullCREG contact key
data.participantobject/nullparticipant details
data.instrumentobjectwebsite or mobile application. RANGE: RealEstateWebsite, MobileApplication, Thing
data.instrument.typestringconst ("RealEstateWebsite")
data.instrument.urlstringformat (uri)
data.event.typeobjecttype of the event e.g Campaign
data.event.namestringany string name
data.event.idstringformat (uri)
data.event.urlstringurl of the event
data.event.subEventsarrayarray of subEvents
data.originatingSystemobjectthe original system where this item was created. Can be of type Thing or any sub-type.

Headers

NameTypeDescription
(root)object-
timestringdate & time the event was produced format (date-time)
agentstringif you are a multi-tenant app, then the agent is the user associated with the event data. any future events related to this message will be sent to the same agent/recipient format (uri)
instrumentstringthe app or service that produced the event on behalf of the agent/user format (uri)
sourcestringa copy of the event was sent to the source(s). format (uri)
originalRecipientstringthe originalRecipient helps you determine the subscription that delivered the event to you. if the originalRecipient is the same as the agent, then the you are subscribed to the agent. if the originalRecipient is different from the agent, then you are subscribed to the event source format (uri)
idstringthe Event ID (aka "Publish ID") is the immutable canonical identifier for the event. it is a URI that is unique to the event and will not change. all subscribers will receive the same id for the same event. format (uri)
@idstringformat (uri)

Tools

Next
Getting started