Going live

Going live

Before you start

Ask your Havnly contact for:

  • an organisation — your company in Havnly, which owns the keys
  • a sandbox key, to build against
  • a live key, when you are ready

Keys are created in API Console → Keys, and shown once.

Build against sandbox

A sandbox key (hvn_sk_…) lets you exercise the full sequence — submit, match, place, dates — without contacting a real landlord or household.

Worth testing before you go live:

  • a request that is missing a field, so you see 422 and the field it names
  • the same external_id twice, so you see "idempotent": true
  • a webhook delivery, including your signature check rejecting a tampered body
  • a request with no coordinates, so you see how an empty match list reads

Going live

  1. Swap the key for the live one. Nothing else changes.
  2. Point your webhook endpoints at production and verify one delivery arrives.
  3. Submit one real housing request and follow it to a signed lease.

Live keys reach real people: landlords are emailed, households are contacted, and contracts are real. Treat the first week as supervised.

Rate limits

No hard limit today. Sustained bursts above a few calls a second will be throttled rather than dropped — if you are planning a bulk load, tell us the shape and we will make room for it.

Getting help

Give us the reference (REQ-…) and roughly when it happened. Every API call is logged our side with its status and duration, so a “400 we could not explain” can usually be answered from here without you digging through your own logs.

  • API Console → Webhooks → Deliveries, for what reached your endpoints
  • Support → Tickets in Havnly, category API / Integration
Errors