Join Channel

Overview

Authenticate and subscribe to your profile's message queue to begin receiving notifications.

Action: joinChannel

Message Format: JSON

Request Parameters

Parameter	Type	Required	Description
`authorizationToken`	string	Yes	Profile authorization token obtained from authentication
`correlationId`	string	Yes	Unique identifier for tracking this request

Request Example

Response

{
  "correlationId": "unique-correlation-id",
  "status": 200,
  "data": {
    "channelId": "019735db-f8f7-6c08-c893-8f3a6f44a244",
    "message": "Successfully joined profile channel."
  }
}

Use Case

After establishing a WebSocket connection, join your profile's channel to subscribe to the message queue. Once joined, you will receive all messages published to your profile's queue, including command status updates and data download links.

The correlation ID allows you to match the response to your request, useful when handling multiple simultaneous operations.

Authorization token must be valid and not expired
Only one active channel subscription per connection
Messages are delivered only after successfully joining the channel
Keep the connection open to continue receiving messages

Join Channel

Overview#

Join Channel#

Request Parameters#

Request Example#

Response#

Use Case#

Overview

Join Channel

Request Parameters

Request Example

Response

Use Case