HomeAdvantage outbound REST API and Data ( HomeAdvantage Sends Data to you)
Outbound API calls are used by the HomeAdvantage system to send data to external platforms. These APIs are crucial for keeping external systems updated with the latest information from HomeAdvantage. The following are the major triggers for updates:
- Confirmation with lead is ingested (return HA opportunity ID)
- Update when agent is assigned
- Update when a note is added.
During the onboarding process, Tech Support will ask you to provide your endpoint and key.
HomeAdvantage Updates (outbound)
Many partners request confirmation of inbound data receipt and other record updates. These are available with primary updates to include.
| AgentName | Name of assigned agent |
| AgentMobile | Assigned agent phone |
| AgentEmail | Asigned agent email |
Milestones and Updates
Additionally, updates may include status milestones that are displayed in the “servicestatus” field.
| Buy Side Milestones | Definition |
| Lead Entered | Referral sent from from partner was received |
| Lead Contact Initiated | Conceirege has initaited contact with buyer |
| Lead Contact Made | Concierge has made contact with buyer |
| New Lead | Buyer has been assigned to a real estate agent |
| Attempted Contact | Agent has attempted to contact buyer |
| Made Contact | Agent has made contact with buyer |
| Appointment Set | Appointment set between agent and buyer |
| Appointment Complete | Appointment completed between agent and buyer |
| Touring | Buyer is actively touring properties |
| Offer Made | An offer has been made to purchase a property |
| Offer Accepted | Offer has been accepted to purchase a property |
| Cancelled | Offer has been cancelled. Cancelleation reason provided in comments |
| Closed | Buyer has closed. |
| Other Lender Name | Name of lender if not using partner |
| Nurture | Buyer is not ready to pursue a purchase at this time, but is being nurtured for a future transaction. |
| Nurture Due Date | Date buyer is slated to come off nuture |
| Inactive Lead | Lead is inactive and no longer being contacted by an agent. |
| Inactive Lead Reason | Reason provided for lead going inactive |
| Note |
Update provided by real estate agent or Mission Control. See separate payload example below. |
| Latest Note |
Note from Concierge or Agent to pass on information. |
| List Side Milestones | Definition |
| Lead Entered | Referral sent from partner was received |
| Lead Contact Initiated | Conceirege has initaited contact with Seller |
| Lead Contact Made | Concierge has made contact with Seller |
| New Lead | Seller has been assigned to a real estate agent |
| Attempted Contact | Agent has attempted to contact seller |
| Contact Made | Agent has made contact with seller |
| Listing Appointment Set | Listing appointment set between agent and seller |
| Listing Appointment Complete | Listing appointment completed between agent and seller |
| Listing Signed | Seller and agent have signed agreement to be listing agent |
| Listed | Seller’s property has been listed for sale |
| Offer Made | An offer has been made on the listed property |
| Offer Accepted | An offer has been accepted on the listed property |
| Cancelled | Offer has been cancelled. Cancelleation reason provided in comments |
| Closed | The property listing has closed |
| Nurture | Customer is not ready tosell at this time, but is being nurtured for a future transaction. |
| Nurture Due Date | Date buyer is slated to come off nurture |
| Inactive Lead | Lead is inactive and no longer being contacted by an agent. |
| Inactive Lead Reason |
Reason provided for lead going inactive |
| Note |
Update provided by real estate agent or Mission Control. See separate payload example below. |
| Latest Note |
Note from Concierge or Agent to pass on information. |
Milestone Update:
Sample payload of Milestone updates sent.
{
“servicestatus”: “Accepted”,
“servicestatusdate”: “01/18/2024 02:36:00 PM”,
“agent”: “AgentName”,
“agentphone”: “555-555-5555″,
“agentemail”: “AgentEmail”,
“agentcompany”: “BrokerageName”,
“PropertyStreet”: “11 Test Street”,
“PropertyCity”: “Tucson”,
“PropertyState”:”AZ”,
“PropertyPostalCode”:”85096″,
“transactiontype”: “Sell”,
“uniquerecordid”:”TestRecord1234″,
“listprice”:”300000″,
“listingdate”:”01/18/2024 02:36:00 PM”,
“expirationdate”:”01/18/2024 02:36:00 PM”,
“mlsname”:”armls”,
“listingid”:”123455″,
“propertyurl”:”https://url”, “listingagentcommission”:”2.5″,
“buyeragentcommission”:”2.5″,
“totalcommission”:”5.0″,
“contractdate”:”01/18/2024 02:36:00 PM”,
“estimatedclosingdate”:”01/18/2024 02:36:00 PM”,
“salesprice”:”310000″,
“mortgagetype”:”Cash Deal”
}
Note Update:
Sample payload of a Note update sent.
{
“servicestatus”: “Note”,
“servicestatusdate”: “01/18/2024 02:36:00 PM”,
“note”:”The customer is making an offer on a property today.“,
“agent”: “AgentName”,
“agentphone”: “555-555-5555″,
“agentemail”: “AgentEmail”,
“agentcompany”: “BrokerageName”,
“PropertyStreet”: “11 Test Street”,
“PropertyCity”: “Tucson”,
“PropertyState”:”AZ”,
“PropertyPostalCode”:”85096″,
“transactiontype”: “Sell”,
“uniquerecordid”:”TestRecord1234″,
“listprice”:”300000″,
“listingdate”:”01/18/2024 02:36:00 PM”,
“expirationdate”:”01/18/2024 02:36:00 PM”,
“mlsname”:”armls”,
“listingid”:”123455″,
“propertyurl”:”https://url”, “listingagentcommission”:”2.5″,
“buyeragentcommission”:”2.5″,
“totalcommission”:”5.0″,
“contractdate”:”01/18/2024 02:36:00 PM”,
“estimatedclosingdate”:”01/18/2024 02:36:00 PM”,
“salesprice”:”310000″,
“mortgagetype”:”Cash Deal”
}
