A AtomicX Chat
Help Sign in

Updated October 27, 2026

Yardi integration

Overview

The Yardi integration connects AtomicX Chat to your Yardi Voyager database. Your chat can then answer leasing questions using your real properties and units, book tours, and send conversation summaries back to Yardi as notes. The integration is currently in Beta.

You need two things before you start:

  • A plan that includes Yardi. If it doesn't, the Yardi card won't appear on Integrations → Integrations, and the settings page says Feature Not Available. To add it, contact support.
  • The Owner or Admin role. Only Owners and Admins can open the Yardi settings and monitoring pages.

Yardi doesn't offer a self-service API key, so you'll also need help from your Yardi Client Success Manager.

Steps

Step 1: Get interface credentials from Yardi

  1. Ask your Yardi Client Success Manager, or open a ticket in Yardi Client Central, to turn on the Yardi Interface for AtomicX Chat on your Voyager database.
  2. Yardi will send you a web services URL, an interface username (API key) and usually an interface password (secret).
  3. Ask Yardi to give the interface read access to properties, units and prospects, plus write access to guest cards and notes.

Step 2: Choose a connector mode

  1. Go to Integrations → Integrations and click Connect (or Manage) on the Yardi card.
  2. Under Connector mode, pick one:
    • REST API: live connection, and Yardi sends changes to AtomicX Chat as they happen. This is the best option.
    • Polling: uses the same credentials, but AtomicX Chat checks Yardi for changes on a schedule. Choose this if Yardi can't send updates over the internet. Enter a Poll interval (seconds). 300 seconds works well.
    • SFTP extract: no live connection. Yardi sends export files every night. Contact support for the SFTP details, then enter the folder path in Drop path.

Step 3: Enter the connection details

  1. For REST API or Polling, fill in:
    • Base URL: the web services URL Yardi gave you.
    • API key: the interface username.
    • API secret (optional): the interface password.
  2. For REST API, send your Yardi contact the webhook endpoint shown in the page's setup guide. Agree on a shared secret with them and paste it into Webhook signing secret. Yardi signs every update with this secret, and AtomicX Chat rejects any update without a valid signature. Each signed update is saved before Yardi gets its reply and applied in the background, usually within 15 seconds. If AtomicX Chat can't save an update, Yardi gets an error (503) and can send it again. An update Yardi sends twice is applied only once.

Step 4: Save, test and pick capabilities

  1. Click Save.
  2. Under Connection test, click Test connection. You'll see Connected, or Failed with the reason.
  3. Under Capabilities, check the features you want AtomicX Chat to use. For example, ReadProperties, ReadUnits, WriteTours or WriteNotes. Only check the ones your Yardi interface license allows.
  4. Click Save again.

Monitor the integration

When your plan includes Yardi, these pages appear under Integrations in the left menu:

  • Yardi sync health shows whether updates to Yardi are flowing. Closed (healthy) means everything's normal. Open (paused) means sending stopped after repeated errors. You can click Pause (manual open) to stop sending on purpose, then Resume (manual reset) to start again. The Outbox section counts updates by status: Pending, In-flight, Succeeded, Failed and Dead-lettered.
  • Yardi operations lists recent updates sent to Yardi, with filters for Operation and Status. Click Apply to filter. To send a failed or dead-lettered update again, click Retry. To drop an update that hasn't succeeded yet, click Discard.
  • An update stays In-flight only while one server is sending it, so it is never sent by two servers at once. If that server stops mid-send, the update is picked up again automatically after about 10 minutes. If it had already used its last attempt, it's Dead-lettered with a note that the Yardi outcome is unknown: check the lead in Yardi before you click Retry.
  • Webhook activity shows the updates Yardi sent you in the last 24 hours and the last 7 days, plus a list of recent events.

Tips

  • On later visits, leave API key and Webhook signing secret blank to keep the saved values.
  • If Webhook activity stays empty when you're in REST API mode, ask your Yardi contact to confirm the webhook endpoint and shared secret.
  • If your plan also includes LeaseX, LeaseX insights and LeaseX funnel appear in the same menu. They show common leasing questions and where prospects drop off.
An unhandled error has occurred. Reload ×