WebSocket Events

Connection Example (JavaScript)

const ws = new WebSocket(
  'wss://ws.oauth42.com/events?token=' + accessToken
);

ws.onopen = () => {
  console.log('WebSocket connected');
};

ws.onmessage = (event) => {
  const message = JSON.parse(event.data);
  handleEvent(message);
};

ws.onerror = (error) => {
  console.error('WebSocket error:', error);
};

ws.onclose = () => {
  console.log('WebSocket disconnected');
};

All WebSocket messages follow a consistent JSON format:

{
  "type": "event_type",
  "timestamp": "2025-01-15T12:00:00Z",
  "data": {
    // Event-specific data
  }
}

session.revoked

Fired when a user session is revoked.

{
  "type": "session.revoked",
  "timestamp": "2025-01-15T15:00:00Z",
  "data": {
    "user_id": "user_12345",
    "session_id": "session_abc123",
    "reason": "manual_revocation",
    "revoked_by": "user_self"
  }
}

token.revoked

Fired when a token is revoked.

{
  "type": "token.revoked",
  "timestamp": "2025-01-15T14:00:00Z",
  "data": {
    "user_id": "user_12345",
    "token_type": "refresh_token",
    "token_id": "token_abc123",
    "reason": "user_logout"
  }
}

user.email.verified

Fired when a user verifies their email address.

{
  "type": "user.email.verified",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "user_id": "user_67890",
    "email": "[email protected]"
  }
}

mfa.backup_code.used

Fired when a backup code is used for authentication.

{
  "type": "mfa.backup_code.used",
  "timestamp": "2025-01-15T18:00:00Z",
  "data": {
    "user_id": "user_12345",
    "remaining_codes": 4
  }
}

client.deleted

Fired when an OAuth client is deleted.

{
  "type": "client.deleted",
  "timestamp": "2025-01-15T19:00:00Z",
  "data": {
    "client_id": "client_xyz789",
    "client_name": "Old Application",
    "deleted_by": "user_12345"
  }
}

Error Messages

Server sends error messages when issues occur:

{
  "type": "error",
  "timestamp": "2025-01-15T12:00:00Z",
  "data": {
    "code": "authentication_failed",
    "message": "Invalid or expired access token"
  }
}

class OAuth42WebSocket {
  constructor(accessToken) {
    this.ws = new WebSocket(
      `wss://ws.oauth42.com/events?token=${accessToken}`
    );
    this.setupEventHandlers();
  }

  setupEventHandlers() {
    this.ws.onopen = () => {
      console.log('Connected to OAuth42 WebSocket');

      // Subscribe to specific events
      this.subscribe([
        'user.login',
        'user.logout',
        'token.revoked',
        'mfa.enabled'
      ]);
    };

    this.ws.onmessage = (event) => {
      const message = JSON.parse(event.data);

      switch (message.type) {
        case 'ping':
          this.pong();
          break;
        case 'user.login':
          this.handleUserLogin(message.data);
          break;
        case 'token.revoked':
          this.handleTokenRevoked(message.data);
          break;
        case 'error':
          this.handleError(message.data);
          break;
        default:
          console.log('Unhandled event:', message);
      }
    };

    this.ws.onerror = (error) => {
      console.error('WebSocket error:', error);
    };

    this.ws.onclose = () => {
      console.log('WebSocket disconnected');
      // Implement reconnection logic here
    };
  }

  subscribe(events) {
    this.ws.send(JSON.stringify({
      type: 'subscribe',
      events: events
    }));
  }

  pong() {
    this.ws.send(JSON.stringify({ type: 'pong' }));
  }

  handleUserLogin(data) {
    console.log('User logged in:', data);
    // Handle login event
  }

  handleTokenRevoked(data) {
    console.log('Token revoked:', data);
    // Redirect to login or refresh token
  }

  handleError(data) {
    console.error('WebSocket error:', data);
    // Handle error appropriately
  }

  close() {
    this.ws.close();
  }
}

// Usage
const ws = new OAuth42WebSocket(accessToken);

// Clean up on unmount
// ws.close();