Subscribe completions

JSON API AsyncAPI›/v2/commands/completions›subscribe

/v2/commands/completions

Subscribe completions

WebSocketSince 3.4Changed 3.5

SUBSCRIBE/v2/commands/completions

Protocol Details

Inputs

Outputs

Either_JsCantonError_CompletionStreamResponse

Variants

CompletionStreamResponse

object

completionResponseobject

Variants

completionResponse

oneOf

Completionobject

Variants

Completion

object

Completionobjectrequired

Empty

object

Emptyobjectrequired

OffsetCheckpoint

object

OffsetCheckpointobjectrequired

JsCantonError

object

codestringrequired

causestringrequired

contextobjectrequired

errorCategorystringrequired

Lifecycle Changes

3.5channel description updated; publish description updated; subscribe description updated

Related Schemas

Either_JsCantonError_CompletionStreamResponse

Variants

CompletionStreamResponse

object

completionResponseobject

Variants

completionResponse

oneOf

Completionobject

Variants

Completion

object

Completionobjectrequired

Empty

object

Emptyobjectrequired

OffsetCheckpoint

object

OffsetCheckpointobjectrequired

JsCantonError

object

codestringrequired

causestringrequired

contextobjectrequired

errorCategorystringrequired

wscat

wscat

npx wscat -c <WEBSOCKET_URL>

messageapplication/json

message

{
  "completionResponse": {
    "Completion": {
      "value": {
        "commandId": "<string>",
        "userId": "<string>",
        "actAs": [
          "<string>"
        ],
        "offset": "<integer>",
        "synchronizerTime": "<object>"
      }
    }
  }
}