API keys and webhooks

Connect HousingStreet to your other tools with API keys and event alerts.

What this is

An API key is a secret password your other software uses to read or write data in HousingStreet.

A webhook is a ping HousingStreet sends to your server when something happens — like a new lead or a sold listing.

Available on:Enterprise

UI path: Settings → Security (API Keys) · Settings → Webhooks

Steps — API keys

1. Open API keys

   Go to Settings → Security. Scroll to API Keys.

2. Create a key

   Click Create key. Give it a name you will remember (for example "CRM sync"). Copy the key right away — you cannot see it again.

3. Use it in your app

   Paste the key into your integration tool. Test one simple call (for example, list properties).

4. Revoke old keys

   Delete any key you no longer use. Treat keys like passwords — never share them in chat or email.

Steps — webhooks

1. Open webhooks

   Go to Settings → Webhooks.

2. Add an endpoint

   Click Add webhook. Paste the URL where your server listens for events.

3. Pick events

   Choose which events to send — for example lead.created or property.updated.

4. Send a test

   Click Test. Your server should receive a sample payload. Fix the URL if it fails.

Expected result

Your other tools can pull data with the API key. Your server gets instant alerts when chosen events happen.

Open webhooks →