Subscribe completions

/v2/commands/completions

WebSocketAdded 3.4 Updated 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

History

Updated3.5

channel description updated; subscribe description updated

Added3.4

wscat

npx wscat -c <WEBSOCKET_URL>

messageapplication/json

message

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

Ledger API

Daml Standard Library

Daml Script

TypeScript

dApp API

Wallet Gateway

Splice APIs

Admin API

Protocol Details

Inputs

Outputs

Either_JsCantonError_CompletionStreamResponse

CompletionStreamResponse

completionResponse

Completion

Empty

OffsetCheckpoint

JsCantonError

Completion

Empty

OffsetCheckpoint

History

​Subscribe completions

​Protocol Details

​Inputs

​Outputs

​Either_JsCantonError_CompletionStreamResponse

​CompletionStreamResponse

​completionResponse

​Completion

​Empty

​OffsetCheckpoint

​JsCantonError

​Related Schemas

CompletionStreamResponse

completionResponse

Completion

Empty

OffsetCheckpoint

JsCantonError

​History

Subscribe completions

Protocol Details

Inputs

Outputs

Either_JsCantonError_CompletionStreamResponse

CompletionStreamResponse

completionResponse

Completion

Empty

OffsetCheckpoint

JsCantonError

Related Schemas

History