Subscribe updates

JSON API AsyncAPI›/v2/updates›subscribe

/v2/updates

Subscribe updates

WebSocketSince 3.4Changed 3.5

SUBSCRIBE/v2/updates

Protocol Details

Inputs

Outputs

Either_JsCantonError_JsGetUpdatesResponse

codestring

causestring

contextobject

errorCategorystring

Lifecycle Changes

3.5channel description updated; publish description updated; publish required fields added: beginExclusive; publish required fields removed: updateFormat; subscribe description updated

Related Schemas

Either_JsCantonError_JsGetUpdatesResponse

codestring

causestring

contextobject

errorCategorystring

wscat

wscat

npx wscat -c <WEBSOCKET_URL>

messageapplication/json

message

{
  "code": "<string>",
  "cause": "<string>",
  "context": {},
  "errorCategory": "<integer>"
}