Case study

UniFi Protect API: decoding the updates WebSocket protocol

UniFi Protect API is a TypeScript client that decodes the controller's undocumented updates WebSocket protocol. Its documentation records the four-frame packet layout, eight-byte headers and payload formats, while the library turns the stream into typed camera and doorbell events.

Targets: Protocol
Category: Independent reconstruction cases
Relationship: Independent reconstruction project
Sources reviewed: 2026-11-06

Stars: 411
Last commit: 2026-11-08
Language: TypeScript

GitHub data as of 2026-11-09

Copy as Markdown View JSON Cite

Requirements & limits

Prerequisites: Node.js 22.20 or later and a UniFi Protect controller account are required.
License: ISC License.

Cite

BibTeX

@misc{unifi-protect-updates-protocol-case,
  title = {{UniFi Protect API: decoding the updates WebSocket protocol}},
  howpublished = {\url{https://github.com/hjdhjd/unifi-protect}},
  url = {https://github.com/hjdhjd/unifi-protect},
  urldate = {2026-11-06},
  note = {Awesome REA entry: \url{https://awesomerea.org/resources/unifi-protect-updates-protocol-case/}}
}

Plain text

UniFi Protect API: decoding the updates WebSocket protocol. https://github.com/hjdhjd/unifi-protect (accessed 2026-11-06). Awesome REA entry: https://awesomerea.org/resources/unifi-protect-updates-protocol-case/

Useful? Star Awesome REA on GitHub2.4k

About this entry

The description was reviewed against primary sources.

Report an outdated entry Suggest a translation fix

Primary sources

README.md GitHub · hjdhjd/unifi-protect · Revision be179c3