Privicore
  1. Websockets
Privicore
  • Privicore API
  • Utility
    • Utility
    • Check server health
      GET
    • Request command id status
      GET
  • Profile
    • Profile Model and Authentication Workflow
    • Register new profile
      POST
    • Authenticate
      POST
    • Retrieve profile id
      GET
    • Change password
      POST
    • Generate qr token for authorization
      POST
    • Reauthorize authorization token
      POST
    • Revoke authorization token
      POST
    • Retrieve token expiry
      POST
  • OAuth Application
    • OAuth Application Management
    • Register OAuth Application
      POST
    • Retrieve OAuth app configuration
      POST
    • Request OAuth app authorization code
      GET
    • Retrieve OAuth app authorization code
      POST
    • Obtain OAuth app access token
      POST
    • OAuth application list
      GET
    • Retrieve OAuth application scope
      GET
    • Refresh OAuth app access token
      POST
  • Public key
    • Public and Private Key Management
    • Generate your private and public keys
    • Register public key
    • Retrieve public key
    • Retrieve CAB public key
  • Data Token
    • Data Token Management
    • Reserve token space
    • Retrieve temporary data token
    • Exchange data for token
    • Upstream file via stream auth
    • Request data via token
    • Download data
    • Configure information security risk meta
    • Configure file meta
    • List data tokens
    • Update data token
    • Delete data
  • Device
    • Device Management
    • Request unique identifier (i.e. Register new device)
    • Retrieve unique identifier
    • Retrieve profile devices
    • Configure device meta
    • Approve device
    • Reject device
    • Retrieve device configuration
    • Remove device
  • Storage
    • Storage Device Management
    • Register storage device
    • List storage devices
    • Synchronize device
    • Remove storage
  • Verified authenticator
    • Authenticator and Voting Management
    • Register authenticator
    • List verified authenticators
    • Retrieve voting strategy
    • Set quorum size
    • Set quorum strategy
    • Set voting time limit
    • Set maximum voting attempts
    • Remove authenticator
    • Register voting configuration
    • Update voting configuration
    • List voting configurations
    • Retrieve voting configuration
  • Policy
    • Policy Management
    • List policy templates
    • Register policy
    • List active policies
    • List inactive policies
    • Activate policy
    • Deactivate policy
    • Delete policy
    • List registered policies
    • Retrieve registered policy
  • Voting
    • Voting Operations
    • Create voting
    • Check pool status
  • Websockets
    • WebSocket Integration
    • Establishing Connection
    • Join Channel
    • Leave Channel
    • Command Status Messages
    • Data Download Messages
  • Schemas
    • Response
      • CommandAccepted
      • Unauthorized
      • ValidationErrors
    • Schemas
    • profileId
    • deviceIdentifier
    • directoryId
    • directoryName
    • directoryShortName
    • givenName
    • familyName
    • createdAt
    • meta
  1. Websockets

Command Status Messages

Overview#

Receive real-time notifications about the completion status of asynchronous commands.

Command Status Messages#

Message Type: X-DPT-CAB-ID

Message Structure#

{
  "data": {
    "type": "X-DPT-CAB-ID",
    "id": "23f7978a-5561-4718-84ca-c38d7db0843c",
    "command_status": 2,
    "body": "Command completed successfully"
  }
}

Message Fields#

FieldDescription
typeMessage type identifier (X-DPT-CAB-ID)
idUnique command identifier returned when operation was initiated
command_statusCurrent status of the command
bodyStatus message or additional information

Command Status Values#

ValueStatusDescription
1PendingCommand is being processed
2SuccessCommand completed successfully
3FailedCommand failed

Handling Messages#

Use Case#

Command status messages provide immediate feedback for asynchronous operations instead of requiring repeated polling. Operations that generate command status messages include:
Profile registration
Device approval/rejection
Public key registration
Data token exchange
Storage device registration
Authenticator registration
Example Workflow:
1.
Initiate profile registration via API
2.
API returns command identifier
3.
Subscribe to WebSocket notifications using the command ID
4.
Receive real-time status updates as registration processes
5.
Handle success or failure immediately
Command IDs are unique and can be used as event identifiers
Messages are delivered only to clients authenticated with the correct profile token
Status value 1 (Pending) may appear multiple times as processing progresses
Always handle both success (2) and failure (3) cases
Remove event listeners after processing to prevent memory leaks
Modified at 2026-01-05 14:08:45
Previous
Leave Channel
Next
Data Download Messages
Built with