website#requestshowing

Message

a website visitor has requested a property showing

Payload Example(s) (generated)

{
  "topic": "realestate/website#requestshowing",
  "time": "2020-06-18T18:30:49Z",
  "agent": "https://bhhs.example.com/profile/card#me",
  "recipient": "https://dev.bhhs.hsfaffiliates.com/profile/card#me",
  "instrument": "https://smarter-agent.example.com/profile/card#me",
  "source": "https://{agentid}.example.com/profile/card#me",
  "identifier": "46wuVafgZ6/e9kGuyImp2vGJuNqYOF6YUHZU0WnOH5U/x5KDCc3mbV0r4OzJ619ZmMTAb88r7Tp3CmQFeSc2Lz/O",
  "data": {
    "type": "RequestShowingAction",
    "identifier": "nwurogb34tnoi3t",
    "agent": {
      "type": "Contact",
      "name": "string",
      "givenName": "string",
      "familyName": "string",
      "email": "user@example.com",
      "telephone": "string",
      "identifier": {
        "bhhsconsumerid": "12345",
        "hsfconsumerid": "6e1d852d-55bb-42b0-8be6-699a505b196e"
      },
      "sameAs": {
        "amcecrmid": 1234567,
        "salesForceId": "parsing"
      },
      "contactPoint": {
        "type": "ContactPoint",
        "name": "Work",
        "telephone": "555-555-5555",
        "faxNumber": "555-555-5555",
        "email": "bob@example.com",
        "url": "https://www.facebook.com/hallandoates"
      },
      "additionalProperties": {
        "workingWithAgent": true
      },
      "additionalProperty": {
        "userPath": "https://www.bhhsheymannwilliams.com/fl/12036-arbor-lake-drive-jacksonville-32225/pid-433020568|12036 Arbor Lake Drive, Jacksonville, FL 32225 - MLS 2146410 - Berkshire Hathaway HomeServices|0"
      },
      "mortgage": false
    },
    "about": {
      "type": "PropertyListing",
      "originatingSystemName": "GOTHAM-MLS",
      "originatingSystemKey": "12345",
      "url": "https://{company-website-url}/{path-to-listing}",
      "streetAddress": "1007 Mountain Gate Rd",
      "addressRegion": "New Jersey",
      "addressLocality": "Gotham City",
      "postalCode": "10010",
      "addressCountry": "USA",
      "listingId": "433020568",
      "listingPrice": {
        "type": "PriceSpecification",
        "price": 7500000,
        "priceCurrency": "USD"
      },
      "listingOriginatingSystem": {
        "type": "MultipleListingService",
        "name": "NEFMLS Northeast Florida (RealMLS)",
        "identifier": {
          "orgId": "flnemls"
        },
        "originatingSystemName": "NEFMLS Northeast Florida (RealMLS)",
        "originatingSystemKey": "2146410"
      }
    },
    "instrument": {},
    "leadOwner": {
      "type": "agent",
      "name": "Tiffany Messer",
      "id": "https://471520.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"
            }
          ]
        }
      ]
    },
    "object": {
      "type": "Question",
      "text": "Populus debet control notitia sua"
    },
    "recipient": {
      "type": "RealEstateAgent",
      "name": "John Smith",
      "id": "https://agentsmith.example.com/profile/card#me",
      "identifier": {
        "hsfid": "1234567890"
      }
    }
  },
  "@id": "https://bhhs.hsfaffiliates.com/outbox/3d9775ff8ecd40bcaeb9f42fbfa15cba",
  "id": "https://aem.bhhs.hsfaffiliates.com/publish/7036ede8196745819a85a9f13a6f12e5",
  "timestamp": 1780002512791,
  "originalRecipient": "https://471520.bhhs.hsfaffiliates.com/profile/card#me",
  "@to": "https://listtracwebsite.bhhs.hsfaffiliates.com/profile/card#me"
}

Payload

NameTypeDescription
(root)object-
topicstringconst ("realestate/website#requestshowing")
sourcestringdata source
instrumentstringformat (uri)
agentstringformat (uri)
timestringdate and time the event was produced
timestampnumberevent timestamp
originalRecipientstringformat (uri)
@idstringformat (uri)
idstringformat (uri)
@tostringformat (uri)
dataobject-
data.typestringconst ("RequestShowingAction")
data.identifierstringunique identifier
data.agentobjecta website user/visitor
data.agent.typestringallowed ("Person", "Contact")
data.agent.namestringfull name
data.agent.givenNamestringfirst name
data.agent.familyNamestringlast name
data.agent.emailstringformat (email)
data.agent.telephonestringtelephone number
data.agent.identifierobjectagent identifier
data.agent.identifier.hsfconsumeridstringHSF consumer identifier
data.agent.sameAsstringvendor specific identifier for the user can be shared with other vendors to identify the user format (uri)
data.agent.contactPointobjectA point of contact for the entity
data.agent.contactPoint.typestringconst ("ContactPoint")
data.agent.contactPoint.namestringa label for the contactPoint, i.e. 'Work', or 'Home'
data.agent.contactPoint.telephonestringtelephone number
data.agent.contactPoint.faxNumberstringfax number
data.agent.contactPoint.emailstringformat (email)
data.agent.contactPoint.urlstringformat (uri)
data.agent.additionalPropertiesobjectadditional properties for the website user
data.agent.additionalProperties.workingWithAgentbooleantrue or false
data.agent.additionalPropertyobjectadditional property for the website user
data.agent.additionalProperty.userPathstringuser path
data.agent.mortgagebooleantrue or false
data.aboutobjectthe PropertyListing
data.about.typestringconst ("PropertyListing")
data.about.urlstringproperty listing URL
data.about.postalCodestringpostal code
data.about.addressRegionstringstate or region
data.about.streetAddressstringstreet address
data.about.addressLocalitystringcity or locality
data.about.addressCountrystringcountry
data.about.listingIdstringunique listing identifier
data.about.listingPriceobjectlisting price details
data.about.listingPrice.typestringconst ("PriceSpecification")
data.about.listingPrice.pricenumberlisting price
data.about.listingPrice.priceCurrencystringuse ISO4217
data.about.originatingSystemNamestringoriginating system name
data.about.originatingSystemKeystringoriginating system key
data.about.listingOriginatingSystemobjectoriginal listing system details
data.about.listingOriginatingSystem.typestringconst ("MultipleListingService")
data.about.listingOriginatingSystem.namestringlisting system name
data.about.listingOriginatingSystem.identifierobjectlisting system identifier
data.about.listingOriginatingSystem.identifier.orgIdstringMLS organization identifier
data.about.listingOriginatingSystem.originatingSystemNamestringoriginating system name
data.about.listingOriginatingSystem.originatingSystemKeystringoriginating system listing key
data.instrumentobjectthe site, app, or service on which the user action was observed
data.leadOwnerobjectlead owner details
data.leadOwner.typestringlead owner type
data.leadOwner.namestringlead owner name
data.leadOwner.idstringformat (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.objectobjectA specific question - e.g. from a user seeking answers online, or collected in a Frequently Asked Questions document
data.object.typestringconst ("Question")
data.object.textstringquestion text
data.recipientobjectrecipient details
data.recipient.typestringallowed ("RealEstateAgent", "RealEstateTeam", "RealEstateOrganization")
data.recipient.namestringrecipient name
data.recipient.idstringformat (uri)
data.recipient.identifieranyrecipient identifier
data.originatingSystemobjectthe original system where this item was created. Can be of type Thing or any sub-type
recipientstringformat (uri)

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