How to create a Buildium API key for Occupella

Occupella connects to Buildium with an API key you create in your own account. It takes about two minutes, and you can revoke the key in Buildium at any time.

  1. Open Developer Tools in Buildium

    In Buildium, open Settings → Developer Tools and pick the API Keys tab.

    If you can’t create a key there, someone who administers your Buildium account can. The setup page has a link that emails them these steps.

  2. Create the key

    Click Create API Key, name it Occupella, and continue through the three steps.

  3. Copy the Client ID and Client Secret

    Buildium shows the Client ID and Client Secret at the end. Keep the page open until both are pasted into Occupella.

  4. Paste them into Occupella

    On occupella.com/start, the Connect Buildium step has a field for each. Pick Production, or Sandbox if the key came from Buildium’s API sandbox, then click Test Buildium connection.

    When the test passes, Save & scan my portfolio starts the first sync.

Live updates, optional

Buildium can send work orders, resident messages, lease events and payments to Occupella as they happen. Without this, Occupella sees them at the next sync. You can skip it during setup.

  1. Add Occupella's address in Buildium

    The Turn on live Buildium updates step shows the address to copy. In Buildium, open Settings → Developer Tools, pick the Webhooks tab and create a subscription with that address. One address takes every event.

  2. Paste the signing secret

    Buildium shows a signing secret once, when the subscription is created. Paste it into the same Occupella step and click Save signing secret.

What the key allows

  • What Occupella reads: properties and units, leases, tenants and balances, owners, vendors and unpaid bills, work orders and tasks. The full list
  • What it can change: the Buildium changes are listed on the features page.
  • How the key is kept: encrypted before it is stored, and never shown again, not even to you.
  • Removing it: revoke the key in Buildium at any time. Disconnecting Buildium in Occupella deletes Occupella’s synced copy of your data.

Have the key? Start the trial

Paste it into the setup page and Occupella runs its first scan of your portfolio. 14 days, no card.