WebSocket API

Zephyr WebSocket API documentation

Overview

Zephyr WebSocket API provides real-time access to Zephyr.

Zephyr runs on port 3753. This value is not currently configurable.

The WebSocket API is built on top of Socket.IO. We recommend using their resources when accessing the WebSocket API. This documentation is organized by event.

API Reference

post-notification

Submit a notification to Zephyr to be displayed in VR.

Payload

{
    "packageName": "com.example.app",
    "id": 35243,
    "timestamp": "1556682824",
    "title": "New message",
    "body": "Hey! How are you?",
    "icon": "<base64 encoded image"
}

• packageName - package name of app which created the notification

• id - random integer to uniquely identify the notification

• timestamp - UNIX timestamp for when notification was created

• body - notification title

• message - notification body

• icon - base64 encoded image to be displayed alongside notification

dismiss-notification

Dismiss a previously submitted notification. This removes the notification from the History tab on the desktop client and SteamVR dashboard.

Payload

{
    "packageName": "com.example.app",
    "id": 35243
}

• packageName - package name of app which originally created the notification

• id - ID of notification to dismiss