Authorization

To interact with the One Record WebSocket service, clients must first authenticate using OAuth 2.0 to obtain an access token. Once authenticated, a WebSocket connection can be established using the provided access token.

Establishing a WebSocket Connection

io('https://ws.one-record.fr/<namespace>', {
  auth: {
    access_token: '<access_token_here>',
  },
});

This connection allows the client to receive real-time notifications for relevant events, such as updates, creations, or deletions of objects related to shipments.

The connection will not be established if the access token is missing or invalid, ensuring that only authorized clients can access the notification stream.