Automation & Integrations

API Access Basics: How Enterprise Integrations Are Set Up

10 min read

On Enterprise, your Admin sets up webhooks in Settings; the read-only external API is granted per integration after our team reviews the scope.

advanced10 min read

On the Enterprise plan, TenancyDesk offers two ways to connect your own systems, and they are set up differently.

Webhooks: set up by your Admin

Webhooks tell your system when something changes in TenancyDesk. Your Admin adds them in Settings → Webhooks — no separate approval is needed. Each delivery is signed, and your system checks the signature with the secret shown when the webhook is created.

External API: granted per integration

The external API lets your system read your agency's records; it is read-only. The plan lets you request it; it is not switched on by itself.

  1. In Settings → API Keys, describe which systems connect and which records they need, then press Send request.
  2. Our team reviews the scope and replies.
  3. Once access is granted, your Admin creates a key there. The key is shown once — store it safely. It reaches only your company's records and can be limited to certain endpoints and IP addresses and given an expiry date.

Where to start

Read the Developer API and Webhooks page, then contact us with the workflow you need.

Step by step

  1. 1

    Webhooks: add them in Settings

    Your Admin adds webhooks in Settings → Webhooks, then saves the signing secret shown when the webhook is created.

  2. 2

    API: send a request

    In Settings → API Keys, describe which systems connect and which records they need, then press Send request.

  3. 3

    API: wait for the review

    Our team reviews the scope and replies. The external API is read-only.

  4. 4

    API: create the key

    Once access is granted, your Admin creates a key; it is shown once and reaches only your company's records.

Was this guide helpful?

Ready to put this into practice?

Start your 14-day free trial and apply what you've learned.

Start Free Trial