website#askquestion

Message

website user asks a question

Payload Example(s) (generated)

{   
    "topic": "realestate/website#askquestion",
    "data": {
        "identifier":"nwurogb34tnoi3t",
        "leadOwner": {
            "type": "RealEstateOrganization",
            "name": "Gotham City Real Estate", //** optional
            "id":"https://example.com/profile.card#me"
        },
        "agent": {
            "name": "String",
            "email": "someone@yahoo.com",
            "telephone": "0011223344",
            "identifier": {
                "hsfconsumerid": "jkevqh598p3h-gkjent-j5n3i"
            },
            "additionalProperty": {
                "userPath": "||https%xyx%123%",
                "coListingAgentType": "Primary"
            },
            "mortgage": false,
            "type": "Person"
        },
        "object": {
            "text": "Hello, is this listing still available? I would like more information about 7158 Golden. Thank you! ",
            "type": "Question"
        },
        "recipient": {
            "id": "https://8675309.domain.com/profile/card#me",
            "name": "String",
            "type": "Organization"
        },
        "about": {
            "url": "https://www.bhhspro.com/mentor/steve-baird/cid-356481/oh/889-hartford-drive-44035/pid-338005633",
            "postalCode": "00000",
            "addressRegion": "MNO",
            "streetAddress": "1234 Lake Valley, DF 12345",
            "addressLocality": "USA",
            "listingId": "9876543",
            "listingPrice": {
                "price": 1234567,
                "priceCurrency": "USD",
                "type": "PriceSpecs"
            },
            "listingOriginatingSystem": {
                "type": "MultipleListingService",
                "name": "XYZ Region MLS (CR)",
                "identifier": {
                    "orgId": "abcde-f"
                },
                "originatingSystemName": "XYZ Region MLS (CR)",
                "originatingSystemKey": "VIM12345"
            },
            "type": "PropertyListing"
        },
        "instrument": {},
        "type": "AskAction",
        "originatingSystem": {
        "type": "SoftwareApplication",
        "name": "RDesk",
        "description": "User Created.",
        "url": "http://www.rdeskwebsite.com/"
      },
    },
    "recipient": "https://8675309.domain.com/profile/card#me",
    "instrument": "https://pod.domain/profile/card#me",
    "@id":"https:/pod.doamin.com/publish/id",
    "id": "https:/pod.doamin.com/publish/id",
    "time": "2024-01-25T18:46:42.056Z",
    "timestamp": 1706208402056
}

Payload

NameTypeDescription
topicstringstring const ("realestate/website#askquestion")
recipienturlthe agent being asked
instrumenturlthe app or service that produced the event on behalf of the agent/user format (uri)
@idurlformat (uri)
idurlformat (uri)
timetimestampdate & time the event was produced format
timestamptimestampdate & time the event was produced format
data.identifierstringunique identifier
data.leadOwner.typestring“RealEstateOffice”,“RealEstateAgent”, “RealEstateTeam”
data.leadOwner.namestringlead Owner name
data.leadOwner.idurlformat (uri)
data.agent.namestringagent name
data.agent.emailemailagent email
data.agent.telephonetelephone numberagent telephone number
data.agent.identifier.hsfconsumeridalpha numerichsf consumer Id
data.agent.additionalProperty.userPathurluri
data.agent.additionalProperty.coListingAgentTypestringcolisting agent type
data.agent.mortgagebooltrue/false
data.agent.typestringagent type
data.object.textstringquestion text
data.object.type?question
data.recipient.idurlrecipient uri
data.recipient.namestringrecipient name
data.recipient.typestringrecipient type
data.about.urlurlabout uri
data.about.postalCodenumberpostal code
data.about.addressRegionstringregion address
data.about.streetAddressstringstreet address
data.about.addressLocalitystringaddress
data.about.listingIdintlistingId
data.about.listingPrice.priceintprice of listing price
data.about.listingPrice.priceCurrencystringCurrency of price
data.about.listingPrice.typestringlisting price type
data.about.listingOriginatingSystem.typestringtype of listingOriginatingSystem
data.about.listingOriginatingSystem.namestringname of listingOriginatingSystem
data.about.listingOriginatingSystem.identifier.orgIdstringorgId
data.about.listingOriginatingSystem.originatingSystemNamestringoriginating system name
data.about.listingOriginatingSystem.originatingSystemKeystringthe listing identifier from the original MLS, aka MLSID.
data.about.typestringPropertyListing
data.instrumentobjectinstrument object
data.typestringconst ("AskAction")
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