NAV Navbar
Logo
JSON .Net Ruby PHP HTTP

MoxiWorks Realtime Stream

Welcome

Welcome to the MoxiCloud Realtime Stream documentation. MoxiWorks Platform Realtime Stream Updates give you instant updates of MoxiCloud data. Once you have set up your integration, you will receive updates instantly as they are made in the MoxiCloud, giving you the ability to better serve your customers.

In this section of the MoxiCloud Docs you’ll find documentation about integrating with the MoxiWorks Realtime Update (PubSub) notifications.

Getting Started

Why choose MoxiWorks Platform Realtime Stream updates?

The following are reasons you might want to utilize MoxiWorks Realtime Stream updates:

1) Instant Updates you get the data in your system as soon as a new listing/contact gets processed by our system. you have first access to new leads, new listings and new data because you’re not waiting for system synchronization – it’s always synchronized. This opens up a whole new range of product possibilities, giving you the ability to enhance your own product offerings and provide even better service to your clients.

 

2) Reduce Costs Instead of bogging down systems while synchronizing data for thousands of records at once, your updates are inherently distributed, ensuring that your systems are always responsive and ready to meet your primary business needs.

 

3) More Control By piping your SNS feed to SQS or to your own internal queueing mechanism allows you the ability to process incoming changes at whatever rate you want. You and your systems control how much data you import at any given time and ensure that rate never causes resource contention issues.

 

This documentation is intended to help you get you set up your MoxiWorks Platform Realtime Update Stream.

Getting Help

During your integration process with MoxiCloud Realtime Stream, your MoxiWorks Platform representative will work with you on getting your Realtime Stream Updates working. If you have any questions about getting set up, please contact your Platform Representative.

Setting Up For Updates

Setup Using An AWS SNS Topic

The MoxiWorks Platform Realtime Stream currently offers updates using Amazon’s Simple Notification Service (SNS). If you are interested in receiving MoxiWorks Realtime Stream Updates using a different method, please talk to your MoxiWorks Platform Representative.

SNS: Configuring For MoxiWorks Platform Realtime Stream Updates

In this section getting your Realtime Stream set up using SNS is covered. Use this to get your incoming MoxiWorks Realtime Stream Updates started. Once you’ve set up your SNS feed to receive updates from the MoxiWorks Realtime Stream you can then configure handling of those messages to best serve your needs. You might configure MoxiWorks Realtime Stream Updates to be sent to your servers or to go to an SQS queue – ensuring you never miss an update. Combining MoxiWorks Realtime Stream Updates with Amazon SNS gives you the flexibility to handle incoming data any way that you need.

Creating an SNS Topic for Realtime Stream Updates
Overview

To receive MoxiWorks Platform Realtime Stream Updates via SNS, first you’ll need to create an SNS topic in your AWS Console and give permissions to MoxiWorks to publish to that SNS topic. This section goes over setting up your SNS Topic. Later, we’ll go into getting data from your SNS Topic to your server.

Production MoxiWorks AWS User: arn:aws:iam::619293852110:user/pubsub-pr

QA MoxiWorks AWS User: arn:aws:iam::619293852110:user/pubsub-qa

Quickstart

If you’re familiar with setting up an SNS topic and giving permissions to a specific user for publishing to that topic, all you’ll need to do is:

1) Give publishing permissions for your topic to the MoxiWorks Platform Stream User in AWS. The platform stream user ID is shown to the right for QA and production environments.

2) Set up a subscription to receive incoming messages from that topic (HTTPS endpoint, SQS, etc.)

3) Let your MoxiWorks Platform Partner Services Representative know what the SNS topic ARN is and whether the topic is for QA or production updates.

SNS Configuration Procedure

If you need a little more help getting the SNS topic and subscription set up, we’ve created an instructional procedure that you can follow.

To set up MoxiWorks Platform Realtime Stream SNS Topic using the AWS SNS Console use the following procedure.

1) From your web browser, go to the Amazon SNS console at console.aws.amazon.com, to open the Amazon SNS Topics dashboard.

 

2) On the Amazon SNS Topics dashboard, click the Create topic button.

AWS Create Topic Button

 

3) From the Details section of the Create topic interface, set the name of the topic. We recommend you utilize something that makes it clear that this is your MoxiWorks Platform Realtime Stream.

AWS Create Topic Set Name

 

4) Click on the disclosure triangle to open the Access Policy section of the Create topic interface.

AWS Console Create topic Access Policy Section

 

5) Ensure Basic method is selected.

AWS Console Create topic Access Policy Choices

 

6) Under the Define who can publish messages to the topic section, click the Only the specified AWS accounts radio button.

AWS Console SNS Define Who Can Publish Choices

 

MoxiWorks Platform Realtime Stream AWS Account ID: 619293852110

7) In the text area that appears, paste the MoxiWorks Platform Realtime Stream AWS Account ID: 619293852110

AWS Console SNS Define Who Can Publish Only Specified Account

 

8) Click the Create topic button to set up the topic.

AWS Console Create topic Button

 

9) In the details view for the SNS topic we just created in steps 1-8, click the Edit button.

AWS Console SNS Topic Details

 

10) Click on the disclosure triangle to open the Access Policy section of the Create topic interface.

fugb"AWS

 

11) Locate the line that gives permission to arn:aws:iam::619293852110:root

AWS Console Edit topic Access Policy JSON Editor

 

12) Change !arn:aws:iam::619293852110:root to arn:aws:iam::619293852110:user/pubsub-pr

Updated AWS Console Edit topic Access Policy JSON Editor

 

13) Click the Save changes button

AWS Console Edit topic Save Changes Button

 

14) Let your MoxiWorks Platform Partner Services Representative know what the SNS topic ARN is and whether it is for QA or production updates.

AWS Console ARN Example Location

 

Once you’ve completed this procedure, your Topic should now be ready to receive MoxiWorks Platform Realtime Stream Updates.

SNS: Receiving Updates

In this section, we’ll look at getting MoxiWorks Platform Realitime Stream Updates to your server; however, this is only one way that you might get data from SNS to your systems. You can investigate all the ways that you can integrate an SNS feed into your systems architecture via AWS help.

Configuring an SNS Topic To Send Updates To An Endpoint via HTTP or HTTPS
Overview

To receive MoxiWorks Platform Realtime Stream Updates from SNS, you’ll need to configure your SNS topic in your AWS Console to forward requests to your server. This section goes over setting up your SNS Topic to pass messages directly to your SNS enabled endpoint.

Quickstart

If you’re familiar with setting up SNS endpoints for data consumption, then all you’ll need to do is: 1) Set up your SNS endpoint on your server.

2) Configure your SNS Topic to point to your server.

SNS Configuration Procedure

If you need help in configuring your SNS Topic to deliver messages to your SNS enabled endpoint, we’ve created this instructional procedure to help you.

To set up your endpoint to receive MoxiWorks Platform Realtime Stream Updates via your SNS Topic, use the following procedure.

1) From your web browser, go to the Amazon SNS console at console.aws.amazon.com, to open the Amazon SNS Topics dashboard.

 

2) On the Amazon SNS Topics dashboard, click the SNS topic that is set up to receive messages.

AWS Console Edit topic

 

3) From the SNS Topic’s details page, click the Create subscription button.

AWS Console SNS Topic Details

 

This will open the Create subscription interface.

 

4) From the Details section, click the Protocol dropdown menu.

AWS Console SNS Topic Subscription Protocol Dropwdown

 

5) Select the appropriate protocol for your incoming SNS messages.

AWS Console SNS Topic Subscription Protocol Dropwdown Selections

 

6) If using HTTP or HTTPS as your protocol, set the URL of the endpoint which you expect to receive messages.

AWS Console SNS Topic Subscription Endpoint Textfield

 

7) Click the Create subscription button to create the subscription.

AWS Console SNS Topic Subscription Create Button

 

Update Handling

The MoxiWorks Platform Realtime Stream is designed to allow you to use the same parsing logic for both Realtime Stream Updates as well as MoxiCloud API calls. Except where noted below, data pushed via Realtime Updates should have have almost exactly shape as objects pulled via MoxiCloud API. Exceptions are noted in the Data Shape sections below.

Payload Metadata

Each message sent to your system by the MoxiWorks Platform Realtime Stream will have metadata associated with the object payload in the root level of the payload. In this section we’ll take a look at the metadata provided in the root level of the response.

Realtime Stream Update Payload Metadata Example
{ 
    "timestamp": 1563912491,
    "type":"/[agent|contact|listing|office]/",
    "action":"/[create|update|upsert|delete]/",
    "data":{
        ...
    }
}
Realtime Stream Update Payload Metadata

As previously noted, the payload of the data sent will (as close as possible) match the MoxiCloud API object shape. For example, each Agent object will match the shape of the Agent that is provided via the MoxiCloud; however, the payload itself is wrapped in an outer scope that provides metadata about the update that would normally be implicitly scoped in a request to the MoxiCloud API. In orderto ensure that incoming updates are routed to the correct parsing logic, you’ll need to inspect the metadata in the payload to determine the kind of update being sent and then route it to the correct logic for parsing and processing.

Attribute Type Notes
timestamp Integer Unix timestamp in full seconds
type String Enumerated set includes agent, contact, listing, office
action String Enumerated set includes create, update, upsert, delete
data Object Update Payload

timestamp This is the Unix timestamp representing the date/time that this Realtime Stream Update was generated. You can utilize the timestamp to ensure that no out-of-order updates occur.

type The type of entity update is in the payload of the message. this will be one of agent, contact, listing or office.

action The action associated with the update. this will be one of create, update, upsert or delete.

data A JSON object representing the entity in the MoxiCloud.

Update Types

The MoxiWorks Platform Realtime Stream provides updates to Agent, Contact, Listing and Office data.

Agent

Agent Update Data

The following attributes make up the payload of the Agent type for a MoxiWorks Platform Realtime Agent Update.

Agent Realtime Update Payload Example
{
"agent_info": {
    "uuid": "8675309e9-1234-dead-beef-deadbeefdead",
    "short_id": "abc123",
    "email_address": "agentemail@agent.email"
},
"client_agent_id":"abc123",
  "mls_agent_id":"MLS_ID",
  "license":"abc123lic",
  "mls_name":"Bob's Better MLS",
  "mls_abbreviation":"BBM",
  "moxi_works_office_id":"8c3f446c-aab9-11e6-9a0f-d0e1408e8026",
  "office_id":"1234",
  "client_office_id":"987123",
  "company_id":"2345",
  "client_company_id":"abc392",
  "agent_id":"67890",
  "office_address_street": "3456 Office Ln.",
  "office_address_street2":"Suite 1234",
  "office_address_city": "Officeville",
  "office_address_state": "AG",
  "office_address_zip": "12345",
  "name": "Buckminster Fuller",
  "first_name": "Buckminster",
  "last_name": "Fuller",
  "main_phone_number": "555) 9101112",
  "mobile_phone_number": "555 333 4567",
  "alt_phone_number": "(555) 567-8910",
  "fax_phone_number": "5557891011",
  "office_phone_number": "(234)456-7890",
  "primary_email_address": "the_agent@agentdomain.com",
  "secondary_email_address": "the_agent_alt@otherdomain.com",
  "email_addresses": {
    "primary": "primary@email.com",
    "display": "display@email.com",
    "alternate": null,
    "moxi_sync": "moxi@email.com",
    "lead_routing": "lead@email.com",
    "zillow": null
  },
  "lead_routing_email_address":"leadrouter@thisdomain.com",
  "title": "Broker",
  "uuid":"8675309e9-1234-dead-beef-deadbeefdead",
  "has_engage_access":true,
  "website_base_url": "mymoxi@website.com",
  "twitter": "https://twitter.com/agentguy",
  "google_plus": "https://plus.google.com/1234567891011121314/posts",
  "facebook": "https://www.facebook.com/moxiworks/",
  "home_page": "foo.com",
  "profile_image_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=200",
  "profile_thumb_url": "http://picturererer.com/pics37/ImageStore.dll?id=852087C5D3A533DD&w=75",
  "service_area_zip_codes": [
    "98117",
    "98105"
  ],
  "company_programs": [
    "Deluxe Listings agent",
    "Very Cool Program Manager"
  ],
  "alternate_offices": [
  {
    "moxi_works_office_id": "abc123",
    "office_id": 1234,
    "office_address_street": "2636 NW Office Street",
    "office_address_street2": null,
    "office_address_city": "Altville",
    "office_address_state": "IN",
    "office_address_zip": "23232",
    "office_phone_number": "813.555.1221"
    },
      {
    "moxi_works_office_id": "xyz789",
    "office_id": 5678,
    "office_address_street": "700 123rd Ave",
    "office_address_street2": "Suite 1234",
    "office_address_city": "Nextus",
    "office_address_state": "AL",
    "office_address_zip": "99899",
    "office_phone_number": "66655544444"
    }
  ]
}
Agent Attributes
Attribute Type
agent_info Object
client_agent_id String
mls_agent_id String or null
license String or null
mls_name String or null
mls_abbreviation String or null
agent_id String
moxi_works_office_id String
office_id String
client_office_id String
company_id String
client_company_id String
office_address_street String or null
office_address_street2 String or null
office_address_city String or null
office_address_state String or null
office_address_zip String or null
name String or null
first_name String or null
last_name String or null
nickname String or null
main_phone_number String or null
mobile_phone_number String or null
alt_phone_number String or null
fax_phone_number String or null
office_phone_number String or null
primary_email_address String or null
secondary_email_address String or null
email_addresses Hash
lead_routing_email_address String or null
title String or null
uuid String
has_product_access Boolean
has_engage_access Boolean
access_level String
website_base_url String or null
twitter String or null
google_plus String or null
facebook String or null
home_page String or null
profile_image_url String
profile_thumb_url String
region String or null
gci_goal Integer
buyer_commission_rate Float
seller_commission_rate Float
service_area_zip_codes Array
alternate_offices Array
available_mls Array
partners Array
company_programs Array
created_timestamp Integer
deactivated_timestamp Integer or null
Attribute Type

client_agent_id This is the ID of the Agent utilized by their company.

mls_agent_id This is the ID of the Agent utilized by their primary MLS.

license This is the number of the license granted to the agent.

mls_name This is the name of the primary MLS for the agent.

mls_abbreviation This is the standard abbreviation of the primary MLS utilized by the agent.

agent_id This is the ID of this Agent. This will be an integer.

moxi_works_office_id This is the MoxiWorks Platform ID of the office for this Agent. This will be an RFC 4122 compliant UUID.

office_id This is the ID of the office for this Agent. This will be an integer.

client_office_id This is the ID of the office for this Agent utilized by their company.

company_id This is the ID of the company for this Agent. This will be an integer.

client_company_id This is the ID of the Company utilized by their company.

office_address_street The street address of the agent’s office. This can be null if there is no data for this attribute.

office_address_street2 The suite or office number of the agent’s office. This can be null if there is no data for this attribute.

office_address_city The city the agent’s office is in. This can be null if there is no data for this attribute.

office_address_state The state or provice the agent’s office is in. This can be null if there is no data for this attribute.

office_address_zip The postal code the agent’s office is in. This can be null if there is no data for this attribute.

name The full name of the agent. This can be null if there is no data for this attribute.

first_name The first name of the agent. This can be null if there is no data for this attribute.

last_name The last name of the agent. This can be null if there is no data for this attribute.

nickname The nickname of the agent. This can be null if there is no data for this attribute.

mobile_phone_number Mobile phone number of the agent. main_phone_number should be considered higher priority, if not the same. This can be null if there is no data for this attribute.

alt_phone_number Alternate phone number for the agent. This should be considered second in priority to main_phone_number. This can be null if there is no data for this attribute.

fax_phone_number This is the agent’s fax phone number. This can be null if there is no data for this attribute.

main_phone_number This is the agent’s main phone number. This number should be considered the number the agent would like to be contacted by. This can be null if there is no data for this attribute.

fax_phone_number This is the agent’s fax phone number. This can be null if there is no data for this attribute.

office_phone_number This is the agent’s office phone number. This can be null if there is no data for this attribute.

primary_email_address This is the agent’s main email address. This email address should be considered the email address the agent would prefer to be contacted by. This can be null if there is no data for this attribute.

secondary_email_address This is the agent’s alternate email address. This email address should be considered the email address the agent would want to be contacted by only if the address in primary_email_address is not functional. This can be null if there is no data for this attribute.

lead_routing_email_address This is the agent’s lead routing email address. This can be null if there is no data for this attribute.

title This is the business title of the agent. This can be null if there is no data for this attribute.

has_product_access Indicates whether the agent has access to MoxiWorks Products.

has_engage_access Indicates whether the agent has access to MoxiWorks Engage.

access_level The access level of the agent.

website_base_url The base url of the agent’s MoxiWorks agent website.

twitter Agent’s Twitter URL. This can be null if there is no data available for this attribute.

google_plus Agent’s Google Plus URL. This can be null if there is no data for this attribute.

facebook Agent’s Facebook page url. This can be null if there is no data for this attribute.

home_page Agent’s website domain. This will be returned without the HTTP(S) prefix. You’ll need to prefix the domain with protocol if using this attribute for an href. This can be null if there is no data for this attribute.

profile_image_url This is a valid URL for a larger size image for the agent. If no agent image has been uploaded for this agent a default image url will be provided.

profile_thumb_url This is a valid URL for a thumbnail size image for the agent. If no agent image has been uploaded for this agent a default image url will be provided.

region The region the agent’s office is in. This can be null if there is no data for this attribute.

gci_goal The agent’s stated gross commission income goal.

buyer_commission_rate Percentage commission rate for the agent when acting as a buyer’s agent.

seller_commission_rate Percentage commission rate for the agent when acting as a seller’s agent.

service_area_zip_codes A list of the lead service area zip codes covered by the agent.

company_programs A list of the company specific program names in which the agent participates or is a member.

created_timestamp This is the Unix timestamp representing the date that this Agent was created in the MoxiWorks system.

deactivated_timestamp This is the Unix timestamp representing the date that this Agent was deactivated in the MoxiWorks system. This will be returned null if the agent is still active.

agent_info Object

The agent_info object contains the IDs that may be used for Agent associations in the MoxiWorks platform based on your use-case.

|uuid|String| |short_id|Integer| |email_address|String|

uuid This is an RFC 4122 compliant UUID associated with the agent.

short_id This will be a four or five character unique alphanumeric identification string.

email_address This is the email address of the agent.

alternate_offices Object

The alternate_offices array contains Dictionary objects representing AlternateOffice entries. The structure of each AlternateOffice entry is shown below.

Attribute Type
moxi_works_office_id String
office_id Integer
office_address_street String
office_address_street2 String
office_address_city String
office_address_state String
office_address_zip String
office_phone_number String

moxi_works_office_id This is the unique identifier for the MoxiWorks Platform AlternateOffice entry.

office_id This is an integer identifier for the MoxiWorks Platform AlternateOffice entry. If you are using MoxiWorks SSO, this will be the ID corresponding to the ID provided there.

office_address_street The street address of the office represented by this AlternateOffice entry.

office_address_street2 The second line of the street address (if required) of the office represented by this AlternateOffice entry.

office_address_city The city portion of the address of the office represented by this AlternateOffice entry.

office_address_state The state portion of the address of the office represented by this AlternateOffice entry.

office_address_zip The postal code portion of the address of the office represented by this AlternateOffice entry.

office_phone_number The phone number of the office represented by this AlternateOffice entry.

available_mls Object

The available_mls Array contains Dictionary objects representing MLS entries. The structure of each MLS entry is shown below.

Attribute Type
name String
display_name String
mls_abbreviation String
agent_id String

name The MoxiWorks internal unique name for the MLS.

display_name The name of the MLS as it is to be displayed to users.

mls_abbreviation The abbreviation of the MLS.

agent_id The agent’s MLS id.

partners Objects

Exstence of objects in the partners data structure is dependent upon external relationships existing between the agent represented by this Agent and the affiliate.

leading_re partner Objects
Attribute Type
salesforce_id String or null
luxury_portfolio Boolean

salesforce_id This is the unique salesforce ID of the company in the LeadingRE system.

luxury_portfolio Indicates whether or not this agent has luxury portfolio association in the LeadingRE system.

email_addresses Object

The email_addresses Hash is a Dictionary object holding the email addresses associated with the Agent record. The structure of the object is shown below.

Attribute Type
primary String or null
display String or null
alternate String or null
moxi_sync String or null
lead_routing String or null
zillow String or null

primary The primary email address associated with the Agent record.

display The display email address associated with the Agent record.

alternate The alternate email address associated with the Agent record.

moxi_sync The moxi_sync email address associated with the Agent record.

lead_routing The lead_routing email address associated with the Agent record.

zillow The zillow email address associated with the Agent record.

 

Differences From API Response

The payload of the Agent update matches the response provided via the MoxiWorks Platform API with the following exceptions:

Attributes Removed
Attribute Use Instead
moxi_works_agent_id use attribute in the agent_info object matching the ID you use in your system to determine the Agent’s ID.
mls_name use the available_mls array to determine the MLSs the agent is a member of.
mls_abbreviation use the available_mls array to determine the MLSs the agent is a member of.
Attributes Added
Attribute Type
agent_info Object
agent_info Payload Example
"agent_info":{
    "uuid":"8675309e9-1234-dead-beef-deadbeefdead",
    "short_id":"abc123",
    "email_address":"agentemail@agent.email"
}
agent_info Object

The agent_info object contains the IDs that may be used for Agent associations in the MoxiWorks platform based on your use-case.

Attribute Type
uuid String
short_id Integer
email_address String

The agent_info object contains the various IDs that can be utilized to identify an agent via the moxi_works_agent_id attribute when sending requests to the MoxiWorks Platform API. Determine which Agent ID your system uses to identify Agents in the MoxiWorks Platform API and map your logic to the appropriate ID contained in the agent_info object.

Contact

Contact Update Data

The following attributes make up the payload of the Contact type for a MoxiWorks Platform Realtime Contact Update.

Contact Realtime Update Payload Example
{
"agent_info": {
    "uuid": "8675309e9-1234-dead-beef-deadbeefdead",
    "short_id": "abc123",
    "email_address": "agentemail@agent.email"
},
 "partner_contact_id": "booyuh",
  "moxi_works_contact_id":"deadbeef-feed-face-bad4dad22dead",
  "moxi_works_lead_source_id": "some_lead_source_id",
  "moxi_works_origin_lead_source_id": "some_other_lead_source_id",
  "is_deleted": false,
  "contact_name":"Firstname Middlenyme Larstnam",
  "first_name":"Firstname",
  "middle_name":"Middlenyme",
  "last_name":"Larstnam",
  "suffix":null,
  "gender": "m",
  "label_name": "Mr. and Mrs. Oo-De-Lally Golly What a Day",
  "primary_email_address":"primary@email.com",
  "secondary_email_address":"secondary@email.com",
  "primary_phone_number":"3603603608",
  "secondary_phone_number":"3603603609",
  "email_addresses": [
    {
      "key": "email_address1",
      "address": "primary@email.com"
    },
    {
      "key": "email_address2",
      "address": "secondary@email.com"
    },
    {
      "key": "email_address3",
      "address": "also@this.com"
    }
  ],
  "phone_numbers": [
    {
      "key": "mobile_phone",
      "number": "3603603608"
    },
    {
      "key": "home_phone",
      "number": "3603603609"
    },
    {
      "key": "business_phone",
      "number": "3603603610"
    },
  ],
  "home_street_address": "1234 Sesame St.",
  "home_city": "Cityville",
  "home_state": "Stateland",
  "home_zip": "12345-6789",
  "home_country": "Ottoman Empire",
  "job_title": "Junior Bacon Burner",
  "occupation": "chef",
  "is_new_contact": true,
  "birthday": 1496310636,
  "anniversary": 1495199540,
  "home_purchase_anniversary": 1484088442,
  "social_media_profiles": [
    {
  "key": "facebook",
  "url": null
  },
    {
  "key": "linkedin",
  "url": null
  },
    {
  "key": "twitter",
  "url": null
  },
    {
  "key": "googleplus",
  "url": null
  }
  ],
  "groups":[
    "this group",
    "that group",
    "the other group"
  ],
  "property_url": "http://my.property.website.is/here",
  "property_mls_id": "abc123",
  "property_street_address": "2345 67th place",
  "property_city": "Townland",
  "property_state": "Statesville",
  "property_zip": "98765-4321",
  "property_beds": "18",
  "property_baths": "12.5",
  "property_list_price": "123456789",
  "property_listing_status": "Active",
  "property_photo_url": "http://property.photo.is/here.jpg",
  "search_city": "Searchland",
  "search_state": "Searchsylvania",
  "search_zip": "12345-6789",
  "search_min_beds": "2",
  "search_min_baths": "3.25",
  "search_min_price": "1234567",
  "search_max_price": "1234569",
  "search_min_sq_ft": "1234",
  "search_max_sq_ft": "1235",
  "search_min_lot_size": "3234",
  "search_max_lot_size": "3235",
  "search_min_year_built": "1388",
  "search_max_year_built": "2044",
  "search_property_types": "Condo, Single Family, Townhouse",
  "websites": [
      {
        "rank": 1,
        "key": "website_key_1",
        "value": "https://blep.com"
      },
      {
        "rank": 2,
        "key": "website_key_2",
        "value": "https://blep.com"
      }
    ],
  "home_purchase_anniversaries": [
      1484088442
   ],
  "company": "Blep Ltd.",
  "spouse_or_partner": "Rick Sanchez"
}
Contact Attributes
Attribute Type
agent_info Object
moxi_works_agent_id* String
partner_contact_id String
moxi_works_contact_id String
moxi_works_lead_source_id String
moxi_works_origin_lead_source_id String
is_deleted Boolean
contact_name String or null
first_name String or null
middle_name String or null
last_name String or null
suffix String or null
gender String or null
label_name String or null
primary_email_address String or null
secondary_email_address String or null
email_addresses Array
primary_phone_number String or null
secondary_phone_number String or null
phone_numbers Array
home_street_address String or null
home_city String or null
home_state String or null
home_zip String or null
home_country String or null
job_title String or null
occupation String or null
company String or null
websites Array
spouse_or_partner String or null
is_new_contact Boolean
birthday Integer or null
anniversary Integer or null
home_purchase_anniversary Integer or null
social_media_profiles Array
groups Array
property_url String or null
property_mls_id String or null
property_street_address String or null
property_city String or null
property_state String or null
property_zip String or null
property_beds String or null
property_baths String or null
property_list_price String or null
property_listing_status String or null
property_photo_url String or null
search_city String or null
search_state String or null
search_zip String or null
search_min_baths String or null
search_min_beds String or null
search_min_price String or null
search_max_price String or null
search_min_sq_ft String or null
search_max_sq_ft String or null
search_min_lot_size String or null
search_max_lot_size String or null
search_min_year_built String or null
search_max_year_built String or null
search_property_types String or null
note String or null
websites Array
home_purchase_anniversaries Array
company String or null
spouse_or_partner String or null
category_names String or null
groups Array

* Either agent_uuid or moxi_works_agent_id will be returned depending on whether it is used in the request. The response payload object’s agent identifier key will match the passed parameter.

agent_uuid This is the MoxiWorks Platform ID of the Agent which this Contact is associated with. This will be an RFC 4122 compliant UUID.

moxi_works_agent_id This is the MoxiWorks Platform ID of the Agent. This will be a string that may take the form of an email address, or a unique alphanumeric identification string.

partner_contact_id This is the unique identifer you use in your system that has been associated with the Contact that you are finding.

moxi_works_contact_id This is the MoxiWorks Platform ID of this Contact. This will be an RFC 4122 compliant UUID.

moxi_works_lead_source_id This is the unique MoxiWorks Platform ID of the LeadSource that generated this Contact.

moxi_works_origin_lead_source_id This is used to keep track of the original lead source for this Contact record. This field will not be displayed in MoxiEngage, and is for the parter’s own tracking purposes. This key will be associated with valid moxi_works_lead_source_id. Send a LeadSource index request for a full list of applicable lead sources and their ids.

is_deleted Will be true if this Contact has been deleted from the Agents contacts.

contact_name This is the full name of the contact you are finding a Contact record for. You should format this information as first middle last. This value will be null if no data is available for this attribute.

first_name This is the first name of the contact associated with this Contact record. This value will be null if no data is available for this attribute.

middle_name This is the middle name of the contact associated with this Contact record. This value will be null if no data is available for this attribute.

last_name This is the last name of the contact associated with this Contact record. This value will be null if no data is available for this attribute.

suffix This is the generational suffix of the name of the contact associated with this Contact record. This value will be null if no data is available for this attribute. Supported suffixes are II III IV JR JR..

gender The gender of the contact. This can be male, female, m or f. No matter what is provided in the request, the response payload will return m or f. This value will be null if no data is available for this attribute.

label_name This is the name used to address the contact when creating mailing labels for the contact associated with this Contact record. This value will be null if no data is available for this attribute.

primary_email_address This is the email address that should be used first. If provided, the address must conform to RFC 3696. This value will be null if no data is available for this attribute. This attribute should not be used in conjunction with the email_addresses attribute.

secondary_email_address This is the email address that should be used as an alternate. If provided, the address must conform to RFC 3696. This value will be null if no data is available for this attribute. This attribute should not be used in conjunction with the email_addresses attribute.

agent_info Object

The agent_info object contains the IDs that may be used for Agent associations in the MoxiWorks platform based on your use-case.

|uuid|String| |short_id|Integer| |email_address|String|

uuid This is an RFC 4122 compliant UUID associated with the agent for this contact.

short_id This will be a four or five character unique alphanumeric identification string.

email_address This is the email address of the agent for this contact.

email_addresses Objects

These email addresses correspond to agent created Contact entities. Only phone fields present in this Contact record will be returned.

Each object in the email_addresses array will have the following structure:

Attribute Type
key String
address String

key The key identifier of the email field. The appropriate email keys are determined by the email server type associated with the Agent. The key identifiers for Agent entities synced to MoxiEngage via a Microsoft Exchange account are: email_address1, email_address2, email_address3. The key identifiers for Agent entities synced to MoxiEngage via a Google account are: home, work, other.

address The email address field value.

primary_phone_number This is the phone number that should be used first. It should be a 10 digit phone number. This attribute should not be used in conjunction with the phone_numbers attribute.

secondary_phone_number This is the phone number that should be used as an alternate. It should be a 10 digit phone number. This attribute should not be used in conjunction with the phone_numbers attribute.

phone_numbers Objects

These phone numbers correspond to agent created Contact entities. Only phone fields present in this Contact record will be returned.

Each object in the phone_numbers array will have the following structure:

Attribute Type
key String
number String

key The key identifier of the phone field. The appropriate phone keys are determined by the email server type associated with the Agent. The key identifiers for Agent entities synced to MoxiEngage via a Microsoft Exchange account are: mobile_phone, home_phone, home_phone2, business_phone, business_phone2, assistant_phone, home_fax, business_fax, car_phone, company_main_phone, other_fax, other_telephone, callback, isdn, pager. The key identifiers for Agent entities synced to MoxiEngage via a Google account are: mobile, home, work, assistant, home_fax, tty_tdd, radio, main, work_fax, car, other, pager, isdn, callback, telex.

number The phone number field value.

home_street_address The contact’s home address street, including number and any suite / apartment number information. This value will be null if no data is available for this attribute.

home_city The city of the contact’s home address. This value will be null if no data is available for this attribute. This value will be null if no data is available for this attribute.

home_state The state of the contact’s home address. This value will be null if no data is available for this attribute.

home_zip The zip code of the contact’s home address. This value will be null if no data is available for this attribute.

home_country The country of the contact’s home address. This value will be null if no data is available for this attribute.

job_title The contact’s professional job title. This value will be null if no data is available for this attribute.

occupation The contact’s profession. This value will be null if no data is available for this attribute.

is_new_contact Whether the contact was recently added to the Agent’s database.

birthday Birthday of the contact represented as a Unix Timestamp.

anniversary Wedding anniversary of the contact represented as a Unix Timestamp.

home_purchase_anniversary Anniversary of the contact’s home purchase represented as a Unix Timestamp.

home_purchase_anniversaries A list of Unix Timestamps representing the contact’s home purchase anniversaries.

company The name of the company associated with the contact.

spouse_or_partner The spouse or partner of the contact.

category_names A comma separated list of the agent’s mail server groups / categories to which this contact belongs.

groups An array of the agent’s mail server groups / categories to which this contact belongs.

websites Objects

Each object in the websites array will have the following structure.

Attribute Type
rank Integer
key String
value String

rank The website’s priority in the contact record.

key The key identifier of the website for use in digesting websites added to the contact record via MoxiEngage

key The url of the website.

social_media_profiles Objects

Each object in the social_media_profiles array will have the following structure.

Attribute Type
key String
url String

key The key identifier of the social media url. Defined keys are ‘facebook,’ ‘linkedin,’ ‘twitter,’ and 'googleplus’

groups Any Agent groups which the contact by name.

property_url This will be a valid URL for a property of interest in your system that can be viewed by the agent. This value will be null if no data is available for this attribute.

property_mls_id This will be the MLS ID of the property of interest. This value will be null if no data is available for this attribute.

property_street_address This will be the street address of the property of interest, including number and suite/apartment number information. This value will be null if no data is available for this attribute.

property_city This will be the city in which the property of interest exists. This value will be null if no data is available for this attribute.

property_state This will be the state or province in which the property of interest exists. This value will be null if no data is available for this attribute.

property_zip This will be the postal code in which the property of interest exists. This value will be null if no data is available for this attribute.

property_beds This will be the number of bedrooms in the property of interest. This value will be null if no data is available for this attribute.

property_baths This will be the number of bathrooms in the property of interest. This value will be null if no data is available for this attribute.

property_list_price This will be the list price of the property of interest. This value will be null if no data is available for this attribute.

property_listing_status This will be the listing status of the property of interest. This can be any arbitrary string, but for best results, this should be a state like Active, Pending, Sold, Cancelled or any other human readable state that would be useful when presented to the agent. This value will be null if no data is available for this attribute.

property_photo_url This will be a valid URL to an image of the property of interest. This value will be null if no data is available for this attribute.

search_city This will be the city / locale used in the listing search criteria. This value will be null if no data is available for this attribute.

search_state This will be the state / region used in the listing search criteria. This value will be null if no data is available for this attribute.

search_zip This will be the zip / postal code used in the listing search criteria. This value will be null if no data is available for this attribute.

search_min_baths This will be the minimum bathrooms used in the listing search criteria. This value will be null if no data is available for this attribute.

search_min beds This will be the minimum bedrooms used in the listing search criteria. This value will be null if no data is available for this attribute.

search_min_price This will be the minimum price used in the listing search criteria. This value will be null if no data is available for this attribute.

search_max_price This will be the maximum price used in the listing search criteria. This value will be null if no data is available for this attribute.

search_min_sq_ft This will be the minimum square feet of the total living area used in the listing search criteria. This value will be null if no data is available for this attribute.

search_max_sq_ft This will be the maximum square feet of the total living area used in the listing search criteria. This value will be null if no data is available for this attribute.

search_min_lot_size This will be the minimum lot size used in the listing search criteria. This value will be null if no data is available for this attribute.

search_max_lot_size This will be the maximum lot size used in the listing search criteria. This value will be null if no data is available for this attribute.

search_min_year_built This will be the minimum allowable year built used in the listing search criteria. This value will be null if no data is available for this attribute.

search_property_types This will be the property types used in the listing search criteria. This can be any arbitrary human readable string, but using recognized property types such as Condo, Single-Family, Townhouse, Land, Multifamily will provide more value to the agent. This value will be null if no data is available for this attribute.

note This is an arbitrary string giving the agent more details about the contact which would not otherwise fit into the Contact record. Any Notes added here will be displayed to the agent in an Activity Log record. Any HTML formatting included will be stripped from the note attribute’s data. This value will be null if no data is available for this attribute.

 

Differences From API Response

The payload of the Agent update matches the response provided via the MoxiWorks Platform API with the following exceptions:

Attributes Removed
Attribute Use Instead
moxi_works_agent_id use attribute in the agent_info object matching the ID you use in your system to determine the Agent’s ID.
agent_uuid use attribute in the agent_info object matching the ID you use in your system to determine the Agent’s ID.
Attributes Added
Attribute Type
agent_info Object
agent_info Payload Example
"agent_info":{
    "uuid":"8675309e9-1234-dead-beef-deadbeefdead",
    "short_id":"abc123",
    "email_address":"agentemail@agent.email"
}
agent_info Object

The agent_info object contains the IDs that may be used for Agent associations in the MoxiWorks platform based on your use-case.

Attribute Type
uuid String
short_id Integer
email_address String

The agent_info object contains the various IDs that can be utilized to identify an agent via the moxi_works_agent_id attribute when sending requests to the MoxiWorks Platform API. Determine which Agent ID your system uses to identify Agents in the MoxiWorks Platform API and map your logic to the appropriate ID contained in the agent_info object.

Listing

Listing Update Data

The following attributes make up the payload of the Listing type for a MoxiWorks Platform Realtime Listing Update.

Listing Realtime Update Payload Example

{
  "LotSizeAcres":0.0,
  "BathroomsFull":3,
  "BathroomsHalf":0,
  "BathroomsOneQuarter":null,
  "BathroomsPartial":null,
  "BathroomsThreeQuarter":null,
  "BathroomsTotalInteger":3,
  "BathroomsTotal":3.0,
  "BedroomsTotal":8,
  "PublicTitle":"Amazingly Remarkable!",
  "PublicRemarks":"Publicalistically Remarkabalistically! REMARKABLE!!",
  "ModificationTimestamp":"2018-03-20T11:04:55.659-07:00",
  "InternetAddressDisplayYN":true,
  "DaysOnMarket":0,
  "ListingContractDate":"07/27/2016",
  "CreatedDate":"11/01/2016",
  "ElementarySchool":"Elementary My Dear School",
  "GarageSpaces":4,
  "WaterfrontYN":false,
  "HighSchool":"Higher Than Junior",
  "AssociationFee":null,
  "ListOfficeName":"Realty Valley United",
  "ListPrice":599000,
  "ListingID":"12323",
  "ListAgentFullName":"Bob Agentson",
  "ListAgentUUID":"8675309e9-1234-dead-beef-deadbeefdead",
  "ListAgentOfficeID":"abc123",
  "ListAgentMoxiWorksOfficeID":"abcd1234",
  "SecondaryListAgentFullName":"Richard Agent",
  "SecondaryListAgentUUID":"8675309e9-2345-dead-beef-deadbeefdead",
  "SchoolDistrict":"Hilltop District",
  "Address":"97 Hilltop Road",
  "Address2":null,
  "City":"Montecarlo",
  "CountyOrParish":"Counting Parishes",
  "Latitude":"47.723251",
  "Longitude":"-122.171745",
  "StateOrProvince":"NV",
  "PostalCode":"87654",
  "Community":"Shady Acres",
  "LotSizeSquareFeet":null,
  "InternetEntireListingDisplayYN":true,
  "MiddleOrJuniorSchool":"*The* Junior High" ,
  "ListOfficeAOR":"WHATEVERS MLS",
  "ListOfficeAORArea":"Area 51",
  "PoolYN":false,
  "PropertyType":"Residential",
  "TaxAnnualAmount":13652,
  "TaxYear":2015,
  "SingleStory":false,
  "LivingArea":3640,
  "ViewYN":false,
  "YearBuilt":1989,
  "OnMarket":true,
  "Status":"active",
  "MoxiWorksListingId":"abc123",
  "AgentCreatedListing":false,
  "VirtualTourURL":"http://the.virtual.tour.url",
  "SharedPartnerData":{
     "attribute_1": "value_1",
     "attribute_2": "value_2"
  },
  "ListingURL":"http://the.listing.url",
  "PropertyFeatures":[
    {
      "PropertyFeatureName": "Kitchen Information",
      "PropertyFeatureValues": [
        "Dishwasher",
        "Microwave",
        "Oven/Range Freestanding"
      ]
      },
      {
      "PropertyFeatureName": "Roof Description",
      "PropertyFeatureValues": [
        "Comp Shingle"
      ]
      },
      {
      "PropertyFeatureName": "Number Of Stories",
      "PropertyFeatureValues": [
        "Two Story"
      ]
      },
        {
      "PropertyFeatureName": "Interior Features",
      "PropertyFeatureValues": [
        "Bath Master",
        "Broadband Internet",
        "Cable/Satellite Tv",
        "Dishwasher",
        "Microwave",
        "Oven/Range Freestanding"
      ]
    }
  ],
  "CompanyListingAttributes": [
    {
      "AttributeId": "the collection",
      "AttributeName": "The Collection"
    },
      {
        "AttributeId": "destination",
        "AttributeName": "Destination"
    }
  ],
  "OpenHouse":[
    {
      "Date":"2018-01-06",
      "StartTime":"13:00:00",
      "EndTime":"15:00:00",
      "VirtualOpenHouseYN":false,
      "VirtualOpenHouseURL":null,
      "Comment":null
      }
  ],
  "ListingImages":[
    {
      "FullURL":"http://images.moxiworks.com/static/images/br/imagoo/default_property_image_wre-326x250.png",
      "GalleryURL":"http://images.moxiworks.com/static/images/br/imagoo/default_property_image_wre-326x250.png",
      "RawURL":"http://images.moxiworks.com/static/images/br/imagoo/default_property_image_wre-326x250.png",
      "SmallURL":"http://images.moxiworks.com/static/images/br/imagoo/default_property_image_wre-326x250.png",
      "ThumbURL":"http://images.moxiworks.com/static/images/br/imagoo/default_property_image_wre-326x250.png",
      "Title":"Image Title",
      "IsMainListingImage":true,
      "Caption":"Image Caption",
      "Description":"Image Description",
      "Width":1024,
      "Height":768,
      "MimeType":"image/jpeg"
      }
  ],
}
Listing Update Data
Attribute Type
LotSizeAcres Float or null
BathroomsFull Integer or null
BathroomsHalf Integer or null
BathroomsOneQuarter Integer or null
BathroomsPartial Integer or null
BathroomsThreeQuarter Integer or Null
BathroomsTotalInteger Integer or null
BathroomsTotal Float or null
BedroomsTotal Integer or null
PublicTitle String or null
PublicRemarks String or null
ModificationTimestamp String
InternetAddressDisplayYN Boolean or null
DaysOnMarket Integer
ListingContractDate String
CreatedDate String
ElementarySchool String or null
GarageSpaces Integer or null
WaterfrontYN Boolean or null
HighSchool String or null
AssociationFee Integer or null
ListOfficeName String or null
ListPrice Integer or null
ListingID String
ListAgentFullName String
ListAgentUUID String
ListAgentOfficeID String
ListAgentMoxiWorksOfficeID String
SecondaryListAgentFullName String or null
SecondaryListAgentUUID String or null
SchoolDistrict String or null
Address String or null
Address2 String or null
City String or null
CountyOrParish String or null
Latitude String or null
Longitude String or null
StateOrProvince String or null
PostalCode String or null
Community String or null
LotSizeSquareFeet Integer or Null
InternetEntireListingDisplayYN Boolean
MiddleOrJuniorSchool String or null
ListOfficeAOR String or null
ListOfficeAORArea String or null
PoolYN Boolean or null
PropertyType String or null
TaxAnnualAmount Integer or null
TaxYear Integer or null
SingleStory Boolean or null
LivingArea Integer or null
ViewYN Boolean or null
YearBuilt Integer or null
OnMarket Boolean or null
Status String or null
MoxiWorksListingId String
AgentCreatedListing Boolean
VirtualTourURL String
SharedPartnerData Hash
ListingURL String or null
PropertyFeatures Array
CompanyListingAttributes Array
OpenHouse Array
ListingImages Array

LotSizeAcres This is the property size of the listing land in acres. If no data is available for this attribute, it will be null.

BathroomsFull This is the number of full bathrooms in the property. If no data is available for this attribute, it will be null.

BathroomsHalf This is the number of half bathrooms in the property. If no data is available for this attribute, it will be null.

BathroomsOneQuarter This is the number of quarter-sized bathrooms in the property. If no data is available for this attribute, it will be null.

BathroomsPartial This is the number of partial bathrooms in the property. If no data is available for this attribute, it will be null.

BathroomsThreeQuarter This is the number of three-quarter bathrooms in the property. If no data is available for this attribute, it will be null.

BathroomsTotalInteger This is the number of rooms that are bathrooms in the property. This is not a summary count of bathrooms by size. If no data is available for this attribute, it will be null.

BathroomsTotal This is the summary count of bathrooms in the property. This will be the number of quarter-bathrooms plus half-bathrooms plus three-quarter bathrooms plus full bathrooms. If no data is available for this attribute, it will be null.

BedroomsTotal This is the number of bedrooms in the property. If no data is available for this attribute, it will be null.

PublicTitle The human-readable title for the listing generated by the property agent. If no data is available for this attribute, it will be null.

PublicRemarks These are human-readable notes about the property generated by the property agent. If no data is available for this attribute, it will be null.

ModificationTimestamp This is a string representing a date on which the listing data was last updated in ISO 8601 format. If no data is available for this attribute, it will be null.

InternetAddressDisplayYN This denotes whether the property should be displayed on a public facing website. If no data is available for this attribute, it will be null.

DaysOnMarket The number of days the listing has been on market.

ListingContractDate This is a string representing a date on which the listing contract was initiated. The string format is MM/DD/YYYY.

CreatedDate This is a string representing a date on which the Listing object was created. The string format is MM/DD/YYYY.

ElementarySchool The elementary school for the property.

GarageSpaces The number of garage spaces that are available at the property.

WaterfrontYN Whether the property is waterfront.

HighSchool The high school for the property.

AssociationFee The home owner’s association fee for the property.

ListOfficeName The name of the listing office.

ListPrice The listed price for the listing.

ListingID The MLS number for the listing.

ListAgentFullName The name of the listing agent.

ListAgentUUID A unique identifier for the listing agent. This will correspond to the uuid field of an Agent.

ListAgentOfficeID A unique identifier for the listing agent’s office. This will correspond to the office_id field of an Office.

ListAgentMoxiWorksOfficeID A unique identifier for the listing agent’s office. This will correspond to the moxi_works_office_id field of an Office.

SecondaryListAgentFullName If there is a second listing agent, the name of the second listing agent.

SecondaryListAgentUUID If there is a second listing agent, the unique identifier for the second listing agent. This will correspond to the uuid field of an Agent.

SchoolDistrict The school district the listing property is in.

Address The street address of the property.

Address2 Additional street address information, for example, suite number.

City City or township the property is located in.

State State or province the property is located in.

PostalCode The zip code or postal code the property is located in.

Community The communitythe property is located in.

LotSizeSquareFeet Total area of the lot.

InternetEntireListingDisplayYN Whether to display information about this listing publicly. If this is false, then the information about this listing should not be visible to the Internet.

MiddleOrJuniorSchool The middle school for the property.

ListOfficeAOR The name of the MLS which this listing is listed with.

ListOfficeAORArea The MLS Area which this listing is in.

PoolYN Whether the property has a pool.

PropertyType The type of property being listed. This can be one of Residential, Condo-Coop, Townhouse, Land, Multifamily

TaxAnnualAmount The total annual property tax.

TaxYear The tax year that the property tax in TaxAnnualAmount was assessed.

SingleStory Whether the building has one story or is multi-story.

LivingArea Total square footage of the building(s) on the property.

ViewYN Whether the property has a view.

YearBuilt The year the living building(s) on the property were built.

OnMarket Whether the listing is currently on-market.

Status Detailed status of the listing; whether it’s active pending contingent

MoxiWorksListingID The unique Identifier for the listing in The MoxiWorks Platform.

AgentCreatedListing Whether the agent created this listing.

VirtualTourURL Virtual tour URL for this listing.

SharedPartnerData A hash containing data shared between MoxiWorks affiliates.

ListingURL Details URL for this listing.

PropertyFeatures Any defined features about the property.

CompanyListingAttributes Company specific attributes associated with the listing. These will be defined by the company & should not be expected to be uniform across companies.

OpenHouse Open house data.

ListingImages Any images of the property.

PropertyFeature Objects

Each object in the PropertyFeatures array will have the following structure.

Attribute Type
PropertyFeatureName String
PropertyFeatureValues Array

PropertyFeatureName Human readable name associated with the feature.

PropertyFeatureValues An array of strings which are human readable values associated with the feature.

CompanyListingAttributes Objects

Each object in the CompanyListingAttributes array will have the following structure.

Attribute Type
AttributeId String
AttributeName String

AttributeId Unique ID for the attribute.

AttributeName Human readable name of the company specific listing attribute.

OpenHouse Objects

Each object in the OpenHouse array will have the following structure.

Attribute Type
Date String
StartTime String
EndTime String
VirtualOpenHouseYN Boolean
VirtualOpenHouseURL String
Comment String

Date YYYY-MM-DD formatted string representing the date of the open house

StartTime HH:MM:SS formatted string representing the time when the open house starts. This is expressed in the local time where the listing is located.

EndTime HH:MM:SS formatted string representing the time when the open house ends. This is expressed in the local time where the listing is located.

VirtualOpenHouseYN Whether the Open House is a Virtual Open House.

VirtualOpenHouseURL If the Open House is a Virtual Open House, the URL that the Virtual Open House is available.

Comment Comments related to the specific Open House showing.

ListingImages Objects

Each object in the ListingImages array will have the following structure.

Attribute Type
FullURL String or null
GalleryURL String or null
RawURL String or null
SmallURL String or null
ThumbURL String or null
Title String or null
IsMainListingImage Boolean
Caption String or null
Description String or null
Width Integer or null
Height Integer or null
MimeType String
EmbededHTMLContent String

FullURL This is a valid URL that can be used for img src to a medium sized representation of the image. This is the medium size image returned in each object in the ListingImages array.

GalleryURL This is a valid URL that can be used for img src to a large sized representation of the image. This is the large size image returned in each object in the ListingImages array.

RawURL This is a valid URL to the raw image as uploaded. This is the largest size image returned in each object in the ListingImages array. Due to variation in size, this image should not be considered for use when displaying images rendered in a browser.

SmallURL This is a valid URL that can be used for img src to a small sized representation of the image. This is the small size image returned in each object in the ListingImages array.

ThumbURL This is a valid URL that can be used for img src to a thumbnail sized representation of the image. This is the smallest size image returned in each object in the ListingImages array.

Title Human readable title of image.

IsMainListingImage Whether this image is considered the primary image for the listing.

Caption Human readable caption for the image.

Description Human readable description of image.

Width Width of the raw image.

Height Height of the raw image.

MimeType MIME or media type of the image.

EmbededHTMLContent Embedded HTML that can be placed into a webpage – this will be used for embedded movies.

 

Differences From API Response

The payload of the Listing update matches the response provided via the MoxiWorks Platform API with the following exceptions:

Attributes Removed
Attribute Use Instead
Attributes Added
Attribute Type

Office

Office Update Data

The following attributes make up the payload of the Office type for a MoxiWorks Platform Realtime Office Update.

Office Realtime Update Payload Example

  {
    "moxi_works_office_id":"feedface-dead-beef-aadf-baddeedc645",
    "id":"1234",
    "client_office_id":"abc123",
    "image_url":"http://the.office.image/image.png",
    "name":"Bob's Better Brokerage",
    "common_name":"Bob's Salsburry Hill Branch",
    "address":"101 South Southerly Street",
    "address2":null,
    "city":"Townseville",
    "county":"Ye Olde Countrie",
    "state":"UM",
    "zip_code":"12123",
    "alt_phone":"8185551212",
    "email":"office@bobsbetterbrokers.erp",
    "facebook":null,
    "google_plus":null,
    "phone":"8185551213",
    "timezone":"Pacific Time (US & Canada)",
    "twitter":null,
    "office_website":"http://the.office.website",
    "region":"WESTERN WASHINGTON"
  }

Office Update Data
Attribute Type
moxi_works_office_id String
id String
client_office_id String
name String or null
common_name String or null
image_url String or null
address String or null
address2 String or null
city String or null
county String or null
state String or null
zip_code String or null
alt_phone String or null
email String or null
facebook String or null
google_plus String or null
phone String or null
timezone String or null
twitter String or null
office_website String or null
region String or null
created_timestamp Integer
deactivated_timestamp Integer or null

moxi_works_office_id This is the MoxiWorks Platform ID of the office for this Office. This will be an RFC 4122 compliant UUID.

id An alternate integer ID of the office. If you are integrating with MoxiWorks Authentication services, you should use this ID.

client_office_id This is the ID of the office utilized by the company.

image_url URL to an image of the office. This can be null if there is no data for this attribute.

name The legal name of the office. This can be null if there is no data for this attribute.

common_name The commonly known name of the office. This can be null if there is no data for this attribute.

address The street address of the office. This can be null if there is no data for this attribute.

address2 The suite or office number of the office. This can be null if there is no data for this attribute.

city The city the office is in. This can be null if there is no data for this attribute.

county The county the office is in. This can be null if there is no data for this attribute.

state The state or provice the office is in. This can be null if there is no data for this attribute.

zip_code The postal code the office is in. This can be null if there is no data for this attribute.

alt_phone Alternate phone number for the office. This should be considered second in priority to phone_number. This can be null if there is no data for this attribute.

email This is the office’s main email address. This email address should be considered the email address the office would prefer to be contacted by. This can be null if there is no data for this attribute.

facebook Office’s Facebook page url. This can be null if there is no data for this attribute.

google_plus Office’s Google Plus account name. This can be null if there is no data for this attribute.

phone_number This is the office’s main phone number. This number should be considered the number the office would prefer to be contacted by. This can be null if there is no data for this attribute.

timezone Timezone the office is in.

twitter Office’s Twitter account name. This can be null if there is no data available for this attribute.

office_website Office’s website URL. This can be null if there is no data available for this attribute.

region The region the agent’s office is in. This can be null if there is no data for this attribute.

created_timestamp This is the Unix timestamp representing the date that this Office was created in the MoxiWorks system.

deactivated_timestamp This is the Unix timestamp representing the date that this Office was deactivated in the MoxiWorks system. This will be returned null if the office is still active.

 

Differences From API Response

The payload of the Listing update matches the response provided via the MoxiWorks Platform API with the following exceptions:

Attributes Removed
Attribute Use Instead
Attributes Added
Attribute Type