# Get WebSocket connection

Opens a persistent WebSocket channel for the specified client_id and streams real-time events defined in the event schema.

Event types:

> .create – includes a current property with the newly created object.
> 
> .update – includes a current property with the updated object and a previous property with the object's prior state.
> 
> .delete – includes a previous property with the deleted object.
> 
> heartbeat – sent at intervals to keep the connection alive.
> 

Use this endpoint to receive live updates (for example on orders, transactions, or journeys) without polling the REST API.

A heartbeat event is sent regularly to keep the connection alive.

Endpoint: GET /v2/partner/client/{client_id}/subscribe
Version: 2.0.0
Security: oAuth

## Path parameters:

  - `client_id` (string, required)
    The ID of requested client.
    Example: "49ad7378-121c-4a53-9894-dfd14a7b4877"

## Response 400 fields (application/json):

  - `error` (string, required)
    Error code
    Enum: "invalid_request"

  - `error_description` (string)
    Description of error

## Response 401 fields (application/json):

  - `error` (string, required)
    Error code
    Enum: "unauthorized"

  - `error_description` (string)
    Description of error

## Response 403 fields (application/json):

  - `error` (string, required)
    Error code
    Enum: "forbidden"

  - `error_description` (string)
    Description of error

## Response 500 fields (application/json):

  - `error` (string, required)
    Error code
    Enum: "server_error"

  - `error_description` (string)
    Description of error

## Response 503 fields (application/json):

  - `error` (string, required)
    Error code
    Enum: "service_unavailable"

  - `error_description` (string)
    Description of error