kuzzle logo mini
  • Kuzzle IoT v3 Customer access
  • Kuzzle Backend v2
  • Kuzzle PaaS
  • Kuzzle AI Agent
    • Guide
    • API
    • Framework
    • SDKs
    • Plugins
    • Modules
    • Drivers
    • Guide
    • API
    • Framework
    • SDKs
    • Plugins
    • Modules
    • Drivers
    • Kuzzle Introduction
    • What is Kuzzle
    • General Purpose Backend
    • Kuzzle Getting Started
    • Run Kuzzle
    • Store and Access Data
    • Set up Permissions
    • Authenticate Users
    • Subscribe to Realtime Notifications
    • Write an Application
    • Create new Controllers
    • Customize the API Behavior
    • Deploy your Application
    • Main Concepts
    • Kuzzle API
    • Data Storage
    • Querying
    • Permissions
    • Authentication
    • Realtime Engine
    • Develop on Kuzzle
    • Embedded SDK
    • API Controllers
    • Event System
    • External Plugins
    • Customize API Errors
    • Elasticsearch
    • Elasticsearch 8
    • Migrate to Elasticsearch 8
    • Kuzzle Advanced
    • Configuration
    • API Keys
    • Secrets Vault
    • Export and Import Data
    • Internal Logger
    • Data Validation
    • Cluster and Scalability
    • Debugging kuzzle
    • Additional Content Types
    • Write plugins
    • Start Writing a Plugin
    • Plugins Features
    • Authentication Strategy
      • Hooks
      • Pipes
      • Controllers
    • Upgrade notes
    • Upgrading from 2.60
    • Upgrading from 2.59
    • Upgrading from 2.56
    • Changelog
    • Kuzzle 2.61
    • Kuzzle 2.60
    • Kuzzle 2.59
    • Kuzzle 2.58
    • Kuzzle 2.57
    • Migrate from Kuzzle 1.x
    • Breaking changes
    • Upgrading Kuzzle
    • Write protocols
    • Start Writing a protocol
      • Introduction
      • ClientConnection
      • RequestContext
      • RequestInput
      • Response headers
      • debug
      • errors
      • log
      • Notify
      • broadcast
      • disconnect
      • init
      • joinChannel
      • leaveChannel
      • Properties
      • execute
      • newConnection
      • removeConnection
    • Write storage drivers
    • Start writing a storage driver
    • The StorageDriver contract
    • Errors
    • Test a driver
    • Publish a driver
  1. What is kuzzle
  2. Write protocols
  3. Write protocols
  • Github
    Contribute to Kuzzle projects
  • Stack Overflow
    Ask a question
  • Discord
    Chat with the community and Kuzzle developers
  • Youtube
    Check out our tutorial videos
©2026 - Kuzzle.io
Apache 2.0 License