API v1.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

join #

Deprecated since 1.8.0

Joins a previously created subscription.

Query Syntax #


Due to the synchronous nature of the HTTP protocol, real-time messaging is not supported

Other protocols #

Copied to clipboard!
  "controller": "realtime",
  "action": "join",
  "body": {
    "roomId": "<subscription identifier>"
  // optional
  "volatile": {}

Arguments #

Optional: #

Body properties #

  • roomId: subscription identifier, returned by Kuzzle during upon a successful subscription

Response #

Returns a roomId property containing the subscription identifier.

Copied to clipboard!
  "status": 200,
  "error": null,
  "index": null,
  "collection": null,
  "controller": "realtime",
  "action": "subscribe",
  "volatile": {},
  "requestId": "<unique request identifier>",
  "result": {
    "roomId": "<unique Kuzzle room identifier>"