Get WebSocket Connection Config

This endpoint provides the necessary configuration details for B2B partners to establish a WebSocket connection with Hermes. By retrieving this configuration, partners can ensure their WebSocket clients are properly set up to communicate with the service.

Endpoint

GET /api/v1/websocket/connection-config

Description

Returns the Hermes connection configuration required for B2B partners. This information is essential for partners to connect their WebSocket clients effectively.

Security

BearerAuth: This endpoint requires a Bearer token for authentication.

Responses

200 OK: The request was successful, and the connection configuration is returned.
- Content-Type: application/json
- Schema: types.SuccessResponse
500 Internal Server Error: An error occurred on the server.
- Content-Type: application/json
- Schema: types.ErrorResponse

Usage

To use this endpoint, ensure that your request includes a valid Bearer token in the Authorization header. The response will provide the necessary configuration details to set up your WebSocket client.