NestBord
Learn
API & Integrations

Using the NestBord API and webhooks

Create read or write API keys, call the REST endpoints, and receive signed webhooks when payments, leases, tenants and maintenance requests change.

November 7, 2026 5 min read

The API lets your own systems read your portfolio data and make changes in NestBord, and webhooks tell those systems when something happens. Both are set up under Settings → API Access (click Manage API Keys). Only organization admins can manage keys and webhooks, and the API needs a plan that includes API access.

Create a key

  1. Type a key name, for example "Zapier" or "Reporting script".
  2. Tick Can write if the key needs to create or change records. Leave it unticked for a read-only key.
  3. Click Create key and copy the key straight away. It starts with nb_live_ and is shown only once.

You can have up to 10 keys. Revoke stops a key immediately.

A write key acts as the admin who created it: the same permissions, checks and trust postings as doing the same thing in NestBord, and every write appears in the activity log as made via that API key. If that person loses staff access, the key's writes stop working and you'll need a new key.

Making requests

The base URL is https://app.nestbord.com/api/v1. Send the key as a Bearer token in the Authorization header:

curl https://app.nestbord.com/api/v1/properties \
  -H "Authorization: Bearer nb_live_..."

Reads return { "data": [...], "total", "limit", "offset" }. Page with ?limit= (default 50, max 100) and ?offset=.

Endpoints

Read:

  • GET /properties: properties with their units.
  • GET /tenants: tenants with their active lease.
  • GET /payments: payments, newest first. Optional ?status=, for example SUCCEEDED.
  • GET /maintenance: maintenance requests, newest first. Optional ?status=, for example OPEN.

Write (needs a key with Can write):

  • POST /tenants: add a tenant, optionally with a lease. Body like { "mode": "manual", "unitId": "...", "tenant": { "name", "email" }, "lease": { ... } }. Use "mode": "invite" to email them a portal invite.
  • POST /leases: create a lease (unitId, tenantId, province, startDate, monthlyRent and so on).
  • PATCH /leases/{id}: change lease terms, such as monthlyRent or endDate.
  • POST /leases/{id}/status: change a lease's status ({ "status": ... }).
  • POST /leases/{id}/charges: add a recurring charge (type, description, amount, optional startDate, endDate).
  • POST /payments: record a payment received outside NestBord (tenantId, leaseId, amount, type, method, optional paidAt, referenceNumber, description). It posts to trust like a payment recorded in the app.
  • POST /maintenance: create a request (unitId, title, description, optional tenantId, priority, category).
  • PATCH /maintenance/{id}: change a request's status (status, optional notes, assignedTo).

Send JSON bodies. Successful writes return { "data": ... }. Errors return { "error": "..." } with a 4xx status, and validation errors add a details field.

Idempotency and limits

Send an Idempotency-Key header on POSTs. If you retry with the same key within 24 hours, you get the first response back (with an Idempotent-Replayed: true header) instead of a duplicate record. Only successful writes are replayed, so a failed request can be fixed and retried with the same key. Reusing a key for a different request returns 422.

curl -X POST https://app.nestbord.com/api/v1/payments \
  -H "Authorization: Bearer nb_live_..." \
  -H "Idempotency-Key: etransfer-CA8q2xT" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"...","leaseId":"...","amount":1450,"type":"RENT","method":"etransfer","referenceNumber":"CA8q2xT"}'

Writes are limited to 120 a minute per key. Over that, you get a 429 with Retry-After: 60.

Webhooks

Under Webhooks, enter an Endpoint URL, tick the events you want and click Add endpoint. Copy the signing secret (it starts with whsec_); it's shown only once. URLs must use https and be on the public internet. You can add up to 10 endpoints.

Events fire whether the change was made in NestBord or through the API:

  • payment.received: a payment was recorded (cash, cheque, e-Transfer, marked received).
  • payment.succeeded: an online or PAD payment succeeded.
  • lease.created, lease.updated, lease.renewed, lease.charge_added.
  • tenant.created.
  • maintenance.created, maintenance.updated.

Each delivery is a POST of JSON: { "id", "event", "createdAt", "data" }, where data is a snapshot of the record. Headers include NestBord-Event, NestBord-Delivery and NestBord-Signature.

Verify the signature

NestBord-Signature looks like t=1730900000,v1=5f2b.... t is the Unix time in seconds, and v1 is the hex HMAC-SHA256 of the string t + "." + rawBody, keyed with your signing secret. Compute it over the raw body exactly as received, before parsing:

const crypto = require("crypto");

function verify(rawBody, header, secret) {
  const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
  const expected = crypto.createHmac("sha256", secret)
    .update(parts.t + "." + rawBody)
    .digest("hex");
  const a = Buffer.from(expected);
  const b = Buffer.from(parts.v1 || "");
  if (a.length !== b.length || !crypto.timingSafeEqual(a, b)) return false;
  // Optional: reject old deliveries
  return Math.abs(Date.now() / 1000 - Number(parts.t)) < 300;
}

Retries and testing

A delivery succeeds when your endpoint returns a 2xx within 10 seconds. Redirects aren't followed. A failed delivery is retried after 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours and 24 hours, then marked failed. After 20 failed attempts in a row, the endpoint is switched off; any success resets the count.

Each endpoint shows its last 10 deliveries with status and error. Use Send test to send a ping event, Retry on a delivery that didn't arrive, and Turn on / Turn off or Delete to manage the endpoint.

Ready to manage your properties with NestBord?

Get started