WebSocket Integration

Connect an external monitoring service in Stellar AIO 4.0 and understand the developer message format.

This guide explains how to connect an external monitoring service to Stellar AIO 4.0 and documents the message format developers must send. It is a connection and protocol reference, not a complete server-building tutorial. Most beginners can skip this optional integration unless their retailer guide or monitoring provider requires it.

It’s perfect for cook groups, monitor providers or developers who want to power Stellar’s WebSocket tab with their own monitoring.

---

What is Stellar’s WebSocket Feature?

Stellar users can now connect to external WebSocket serversfrom the WebSockets tab in Stellar AIO 4.0. A WebSocket is a live connection that lets an external service send product updates to Stellar. This optional integration is separate from the old built-in server-side monitoring instructions. Follow your retailer guide for task preparation.

This gives you the power to:

• Run your own monitors and deliver custom product pings to users
• Monetize or enhance your group offerings with Stellar compatible support
• Push lightning fast restock info from your own backends into Stellar tasks

---

How Does It Work?

Open WebSockets in the sidebar and choose Add Websocket. In Add Socket Connection, enter a recognizable Socket Name and the Socket URL supplied by your provider, then select Add. The URL is the address of the external service (ws:// or wss://). Check the connection status in the WebSockets list. If you do not use an external monitoring provider, you do not need to add a connection. Keep URLs containing private keys out of screenshots and public messages.

Your server should:

• Accept connections from authenticated Stellar users
• Broadcast product pings to all connected users in Stellar’s accepted format
• Optionally restrict or track key usage (for private servers)

---

How Do I Build a Compatible WebSocket Server?

You can use any backend language or framework as long as it:

• Accepts WebSocket traffic (port 80 for ws://, or 443 for wss:// via reverse proxy like NGINX)
• Sends properly formatted stringified JSON payloads
• Authenticates users by API key (via query string)

We recommend building with Node.js, Python, Go, or Rust for ease of development and scale but any language that supports WebSocket libraries will work.

---

Websocket Format

Amazon Format

Required for Amazon connections:

• region, sku, and offerId are required
• productImage must be a valid URL
• productPrice must be a string
• Supported Regions:
  ['US', 'CA', 'UK', 'NL', 'FR', 'IT', 'DE', 'ES', 'BE', 'PL', 'AU']

{
  "site": "amazon",
  "region": "US",
  "sku": "B09MQ5L5N9",
  "offerId": "OID",
  "details": {
    "productTitle": "Amazon Test",
    "productImage": "https://www.image.com/",
    "productPrice": "199.99"
  }
}

All Other Sites

• sku is always required
• offerId is only used for Walmart USA/CA
• productImage must be a valid URL
• productPrice must be a string

{
  "site": "exactly like in task creator",
  "sku": "SKU required",
  "offerId": "only Walmart USA/CA",
  "details": {
    "productTitle": "Example Product",
    "productImage": "https://www.image.com/",
    "productPrice": "199.99"
  }
}

warning

Due to the number of supported sites, not all have been individually tested. We strongly recommend testing your WebSocket with an in stock item and if detection doesn’t work, open a ticket and we'll tag the dev team.

---