join #

Joins a previously created subscription.

Query Syntax #

HTTP #

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

Other protocols #

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

Arguments #

Optional: #

volatile: subscription information, used in user join/leave notifications.

Body properties #

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

Response #

Returns a roomId property containing the subscription identifier.

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

Edit this page on Github