← All Connectors
Ubiquiti UniFi

Ubiquiti UniFi

unifi

Self-hosted or UniFi Cloud controller. Connects via the controller REST API for client tracking, device management, and site-level analytics.

Configuration schema

FieldTypeRequiredDescription
controller_urlstringYesURL of your UniFi Controller (e.g., https://192.168.1.1:8443 or https://unifi.ui.com).
usernamestringYesController admin username for API authentication.
passwordstringYesController admin password. Encrypted at rest with AES-256-GCM.
sitestringNoSite name (default: "default"). Found in Settings > Site.

Setup instructions

1

Ensure your UniFi Controller is accessible from the internet (or set up a tunnel).

2

Create a local admin account for API access (avoid using your main account).

3

Note your site name from Settings > Site in the controller UI.

4

Register the integration via POST /api/venues/:id/integrations with connector_type "unifi".

5

The connector will poll the controller API at configurable intervals for client data.

Webhook / polling format

unifi-webhook.json
// UniFi uses polling, not webhooks.
// The connector calls these controller endpoints:
// GET /api/s/{site}/stat/sta     — active clients
// GET /api/s/{site}/stat/device  — access points
// GET /api/s/{site}/stat/health  — site health

Normalized canonical event

After normalization, the connector output becomes a standard GNCanonicalEvent:

canonical-event.json
{
  "event_type": "device_connected",
  "venue_id": "v_abc123",
  "zone_id": null,
  "device_hash": "hmac_sha256_f1e2d3c4b5a6",
  "timestamp": "2026-03-15T15:00:00.000Z",
  "connector_type": "unifi",
  "metadata": {
    "signal_strength": -55,
    "ssid": "Office-WiFi",
    "ap_name": "UAP-AC-Pro-Lobby",
    "channel": 36
  }
}

Next steps