Getting access

You build and test against our pre-production environment first. Once a test tenancy has worked end to end, we issue production credentials. For every step on this page, email tellmemore@lettingshub.co.uk.

The API signs in with a BOX user. BOX is the platform The Lettings Hub runs tenancies and referencing on; the user is the same kind of login an agency's staff use, set up for your integration.

1. Talk to us about what you need

If you are new to The Lettings Hub, start here. Tell us what your integration will do and for which agencies, and we will take you through the products and pricing that fit. You can read these docs and design against them before then; you need credentials only to send your first call.

2. Ask for pre-production access

When you are ready to build, our integrations team sets up your test access. Send us:

• your company name, and the agency you are building for if that is not you;
• the name and email address of the developer we should talk to;
• the email addresses you will give your test tenants and guarantors (see Testing your integration for why);
• your webhook URL if you want webhooks from the start: HTTPS, accepting POST with a JSON body. Add a header name and value if you want us to send one on every delivery.

3. What you receive

• A test agency of your own on pre-production, with one branch.
• A BOX user on that branch: a username and a password.
• The branch Id, which you pass when you create a tenancy. GET /Branches returns it too.
• Webhooks pointed at your URL, if you sent one.

The test agency is yours alone. Other partners do not see your tenancies, and your webhooks carry only your test data.

Keep the password in a secret store, not in source code or a ticket. If it leaks, email us and we will reset it.

4. Build and test

Start with Getting started to sign in and list your branch, then follow Tenancy & Referencing Management. Testing your integration explains how pre-production differs from production and lists what to check before you go live.

5. Go live

When you have taken a test tenancy all the way through (created it, submitted a tenant, received the report webhook and fetched the report PDF), email us to go live. We then:

• create a user on the live branches you will raise work against;
• send you the production base URL;
• set your production webhook URL and header.

Changing settings later

You cannot change your webhook URL, header, users or branches through the API. Email us and we will change them.