Subscribe active contracts

JSON API AsyncAPI›/v2/state/active-contracts›subscribe

/v2/state/active-contracts

Subscribe active contracts

WebSocketSince 3.4Changed 3.5

SUBSCRIBE/v2/state/active-contracts

Protocol Details

Inputs

Outputs

Either_JsCantonError_JsGetActiveContractsResponse

Variants

JsCantonError

object

codestringrequired

causestringrequired

contextobjectrequired

errorCategorystringrequired

JsGetActiveContractsResponse

object

workflowIdstring

contractEntryobject

streamContinuationTokenstring

Variants

contractEntry

oneOf

JsActiveContractobject

Variants

JsActiveContract

object

JsActiveContractobjectrequired

JsEmpty

object

JsEmptyobjectrequired

JsIncompleteAssigned

object

JsIncompleteAssignedobjectrequired

JsIncompleteUnassigned

object

JsIncompleteUnassignedobjectrequired

Lifecycle Changes

3.5channel description updated; publish description updated; publish required fields removed: eventFormat; subscribe description updated

Related Schemas

Either_JsCantonError_JsGetActiveContractsResponse

Variants

JsCantonError

object

codestringrequired

causestringrequired

contextobjectrequired

errorCategorystringrequired

JsGetActiveContractsResponse

object

workflowIdstring

contractEntryobject

streamContinuationTokenstring

Variants

contractEntry

oneOf

JsActiveContractobject

Variants

JsActiveContract

object

JsActiveContractobjectrequired

JsEmpty

object

JsEmptyobjectrequired

JsIncompleteAssigned

object

JsIncompleteAssignedobjectrequired

JsIncompleteUnassigned

object

JsIncompleteUnassignedobjectrequired

wscat

wscat

npx wscat -c <WEBSOCKET_URL>

messageapplication/json

message

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