CCPEDIAby Unity Nodes
Documentation/Canton Network Docs/Ledger APIAsyncAPI/v2/commands/completionsView on Canton Network Docs ↗

Subscribe completions

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

/v2/commands/completions

​
Subscribe completions

WebSocketUpdated 3.5
/v2/commands/completions
Deprecated: please use GetCompletions instead. Subscribe to command completion events.

​
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

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

​
History

Updated3.5

channel description updated; subscribe description updated

wscat
wscat
npx wscat -c <WEBSOCKET_URL>
messageapplication/json
message
{
  "completionResponse": {
    "Completion": {
      "value": {
        "commandId": "<string>",
        "userId": "<string>",
        "actAs": [
          "<string>"
        ],
        "offset": "<integer>",
        "synchronizerTime": "<object>"
      }
    }
  }
}