Notification API
AstralOverlay accepts notifications from applications running on the same computer.
| Transport | Address | Use |
|---|---|---|
| WebSocket | ws://127.0.0.1:42070/?client=YourApp |
Recommended for new integrations |
| UDP | 127.0.0.1:42069 |
Legacy integrations |
Enable Notification API in AstralOverlay before connecting.
One notification system
Section titled “One notification system”Both transports feed the same notification queue and card renderer. Notifications appear one at a time, with up to 32 waiting behind the current card. If the waiting queue fills, the oldest waiting notification is dropped.
The transport queues are also bounded. This is a lightweight display API, not durable message delivery.
Choose a guide
Section titled “Choose a guide”- Send a WebSocket notification.
- Look up payload fields.
- Use the legacy UDP format.
- Understand XSOverlay compatibility.
These local ports are unrelated to this documentation website. Do not point integrations at docs.astraloverlay.dev.