Your browser does not support JavaScript!

Setup Instructions: Yardi RentCafé Integration

Use this setup guide to integrate ACE™ Virtual Leasing Assistant with Yardi RENTCafé for pricing and availability and calendar appointment availability.

Last Update:
April 1, 2021
ACE
Implementation

About the Integration

ACE integration with RENTCafé encompasses the ability to pull pricing and availability and send prospect guest cards and appointments based on calendar availability to RENTCafé.

Yardi supports integrations for various Yardi products (Voyager, RENTCafé, etc.). For LeaseHawk to properly integrate, we must understand how pricing/availability, leads and appointments are managed by the leasing team prior to initiating the integration. The information contained in this integration guide is specific to RENTCafé only, not Voyager. If there is uncertainty on which integrations are required, please contact your LeaseHawk sales representative.

Version Requirements

Confirm your company is listed on the LeaseHawk – Yardi API Access Agreement.

Yardi requires that all clients requesting integration with LeaseHawk be included in an existing API access agreement between Yardi and LeaseHawk. Please work with your LeaseHawk sales representative and RentCafé account executive to be added to the agreement if not already included. Onboarding cannot begin until this step is complete.

What LeaseHawk Will Need from You

Please provide the required information to LeaseHawk and complete the following steps to ensure proper configuration of the RENTCafé integration. If you need assistance obtaining this information, request it from your RENTCafé representative.

If ACE will be pulling Unit Pricing and Availability from RENTCafé:

  1. Web Services API Token. Please request the company-specific API Token from Yardi if necessary. Note: The Web Service API Token is different than the Marketing API Key.
  1. Username and password. The user and password associated with the API Token can be obtained from your RENTCafé CSM or Technical Support.
  1. Property Code. Please provide the RENTCafé “p” code for each property to be configured.
  1. Property name. Please provide the property name associated with each property code.
  1. Enabled Web Services API. Please reach out to your RENTCafé rep or Technical Support to ensure the API is enabled.

If ACE will be accessing the RENTCafé calendar to schedule appointments:

  1. Marketing API Key. Please request the company specific API Key from Yardi if you do not have it.  Please note that the Marketing API Key is different than the Web Service API Token.
  1. Company Code. You must request your company code from Yardi if you do not have it.
  1. Property Code. Please provide the RENTCafé “p” code for each property to be configured.
  1. Enable Appointment Availability API. This setting (shown below) must be checked as ON in the Site Manager for each property. This is an admin level setting and must be enabled by RENTCafé.

  1. Enable Marketing API. This setting must be checked ON as shown below. You can access this field in Company Configuration > Settings > Company Level Settings > Domain & Website Settings. Then, click the checkbox for Allow Marketing functions for 3rd party marketing websites.

  1. Enable Publishing on Marketing API. Have your Yardi representative navigate to the Property > Property Configuration > Settings > Yardi Staff Admin Settings. Then, check Publish on Marketing API, as shown below.

If ACE will be sending leads directly to RENTCafé:

  1. Web Services API Token. Please request the company-specific API Token from Yardi if necessary. Note: The Web Service API Token is different than the Marketing API Key.
  1. Username and password. The user and password associated with the API Token can be obtained from your RENTCafé CSM or Technical Support.
  1. Property Code. Please provide the RENTCafé “p” code for each property to be configured.
  1. Property Name. Please provide the property name associated with each property code.
  1. Enabled Web Services API. Please reach out to your RENTCafé rep or Technical Support to ensure the API is enabled.

RENTCafé Lead and Tour Integration Overview

How It Works

To be identified as a prospect, ACE must capture contact information such as phone or email. The lead must also show leasing intent by asking a leasing question or scheduling a tour.

Once a prospect has been identified and contact information has been collected, ACE will:

  • Send an email to the property email address with the guest card information.

Once a prospect has scheduled a tour, ACE will:

  • Send an email to the property email address with appointment information.

Once a prospect has completed a conversation with ACE, ACE will:

  • Send the guest card information to Yardi RENTCafé. If configured properly within your RENTCafé instance, the guest card will automatically appear in the Unreviewed Queue. The guest card information should also propagate to Voyager and be given a “p” code.
  • If a tour was scheduled, ACE will send the appointment information to RENTCafé.
  • Voyager and RENTCafé will link the guest card and appointment together and may notify the agent to link them together during the leasing process if they are not merged automatically.

To ensure the delivery of emails to the property, each property should configure noreply@leasehawk.com as a safe sender to prevent emails from being marked as spam.

Optional Integration Configuration

No optional configurations available.

Additional Information

When adding the ACE Chatbot script to your property website, you must add the script in the “analytics tracking” section within RENTCafé (shown below), which propagates it to all property pages.

What Information is Sent to RENTCafé?

When a prospect completes a conversation with ACE, the following information should be received by RENTCafé as part of the guest card, if it was provided by the prospect.

  • First Name
  • Last Name
  • Phone Number
  • Email
  • Ad Source
  • Transcription of the conversation

When a prospect schedules an appointment with ACE, the following information should be received by RENTCafé as part of the guest card, if it was provided by the prospect.

  • First Name
  • Last Name
  • Phone Number
  • Email
  • Requested appointment date and time

Ready to Get Started?

Contact support@leasehawk.com or your LeaseHawk Implementation Manager with the information in the "What LeaseHawk Will Need from You" section above. Our team is ready to help you get integrated!