website#subscribemarketactivityreport

Message

website user (data.agent) has viewed a listing (data.object) on a webiste or mobile app (data.instrument)

Payload Example(s) (generated)

{
  "topic": "realestate/website#subscribemarketactivityreport",
  "recipient": "https://bhhs.hsfaffiliates.com/profile/card#me",
  "time": "2025-10-22T19:32:25.070Z",
  "agent": "https://dev.bhhs.hsfaffiliates.com/profile/card#me",
  "instrument": "https://aem.dev.bhhs.hsfaffiliates.com/profile/card#me",
  "source": "https://3025032.dev.bhhs.hsfaffiliates.com/profile/card#me",
  "originalRecipient": "https://3025032.dev.bhhs.hsfaffiliates.com/profile/card#me",
  "@id": "https://buyside.dev.bhhs.hsfaffiliates.com/inbox/3434bd642e9a4b2895bbbf249237dee0",
  "id": "https://aem.dev.bhhs.hsfaffiliates.com/publish/9fa612070b404906a8199815bdc7e52c",
  "timestamp": 1761161545070,
  "data": {
    "type": "SubscribeAction",
    "identifier": "fh4ZKKBoPq30xe+PHrAThkoCvk1Gk+2dJMMqaVeVWmf60S/DiM0lqfTQwQdWYQt7NHZdE4dmLE9QHMO+STOKqxAw",
    "agent": {
      "type": "Contact",
      "name": "siva puli",
      "givenName": "siva",
      "familyName": "puli",
      "email": "sivapuli@hsfranchise.com",
      "identifier": {
        "hsfconsumerid": "9d3e622e-93db-4ca3-81ce-e65ded030e26"
      },
      "additionalProperty": {
        "userPath": "https://www.dev.bhhs.com/grayling-properties-ak702/grayling/molly-grayling/cid-3025032/market-activity/campaignId-701Wj00000iWTS9IAO%3BConsumer%20Market%20Activity%20|%20Molly%20Grayling%20|%20Berkshire%20Hathaway%20HomeServices%3B1",
        "workingWithAgent": false
      }
    },
    "participant": {
      "type": "RealEstateAgent",
      "id": "https://3025032.dev.bhhs.hsfaffiliates.com/profile/card#me"
    },
    "instrument": {
      "type": "RealEstateWebsite",
      "url": "https://3025032.dev.bhhs.hsfaffiliates.com/profile/card#me"
    },
    "object": {
      "type": "PropertyValueReport",
      "propertyType": "Single Family",
      "addressCountry": "US",
      "addressLocality": " Santa Ana",
      "addressRegion": "CA",
      "postalCode": "92707",
      "streetAddress": "1234 E Borchard Ave",
      "image": [],
      "latitude": 42.111904,
      "livingArea": {
        "type": "QuantitativeValue",
        "unitCode": "SqFt",
        "unitText": "Square Feet",
        "value": 1104
      },
      "longitude": -72.68681,
      "lotSize": {
        "type": "QuantitativeValue",
        "unitCode": "SqFt",
        "unitText": "Square Feet",
        "value": 15264
      },
      "numberOfBathrooms": 2,
      "numberOfBedrooms": 3,
      "yearBuilt": 1988
    },
    "leadOwner": {
      "type": "RealEstateAgent",
      "name": "Molly Grayling",
      "id": "https://3025032.dev.bhhs.hsfaffiliates.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#subscribemarketactivityreport")
recipientstringformat (uri)
timestringdate and time the event was produced
agentstringformat (uri)
instrumentstringformat (uri)
sourcestringformat (uri)
originalRecipientstringformat (uri)
@idstringformat (uri)
idstringformat (uri)
timestampnumberevent timestamp
dataobjectthe message payload. RANGE: SubscribeAction
data.typestringconst ("SubscribeAction")
data.identifierstringunique identifier
data.agentobjectwebsite user details
data.agent.typestringallowed ("Person", "Contact")
data.agent.namestringfull name
data.agent.givenNamestringfirst name
data.agent.familyNamestringlast name
data.agent.emailstringformat (email)
data.agent.identifierobjectagent identifier
data.agent.identifier.hsfconsumeridstringHSF consumer identifier
data.agent.additionalPropertyobjectadditional property details
data.agent.additionalProperty.userPathstringuser path
data.agent.additionalProperty.workingWithAgentbooleantrue or false
data.participantobjectparticipant details
data.participant.typestringconst ("RealEstateAgent")
data.participant.idstringformat (uri)
data.instrumentobjectwebsite or mobile application details
data.instrument.typestringconst ("RealEstateWebsite")
data.instrument.urlstringformat (uri)
data.objectobjectsubscribed market activity report property details
data.object.typestringconst ("PropertyValueReport")
data.object.propertyTypestringproperty type
data.object.addressCountrystringcountry
data.object.addressLocalitystringcity or locality
data.object.addressRegionstringstate or region
data.object.postalCodestringpostal code
data.object.streetAddressstringstreet address
data.object.imagearrayproperty images
data.object.latitudenumberlatitude
data.object.longitudenumberlongitude
data.object.livingAreaobjectliving area details
data.object.livingArea.typestringconst ("QuantitativeValue")
data.object.livingArea.unitCodestringunit code
data.object.livingArea.unitTextstringunit text
data.object.livingArea.valuenumberliving area value
data.object.lotSizeobjectlot size details
data.object.lotSize.typestringconst ("QuantitativeValue")
data.object.lotSize.unitCodestringunit code
data.object.lotSize.unitTextstringunit text
data.object.lotSize.valuenumberlot size value
data.object.numberOfBathroomsnumbernumber of bathrooms
data.object.numberOfBedroomsnumbernumber of bedrooms
data.object.yearBuiltnumberyear built
data.leadOwnerobjectlead owner details
data.leadOwner.typestringlead owner type
data.leadOwner.namestringlead owner name
data.leadOwner.idstringformat (uri)
data.eventobjectevent details
data.event.typeobjecttype of the event e.g Campaign
data.event.namestringany string name
data.event.descriptionstringevent description
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