Streamer overlay
Use this recipe when a creator wants a browser source for OBS or streaming software: table status, tournament state, or results, without player controls.
Status: design preview. PokerWorks already has public-safe read and hosted-table primitives in first-party products, but the external self-serve overlay contract is not promoted yet.
What you build
- A server-owned overlay page that reads approved public-safe poker state.
- A browser-source URL for OBS or a similar tool.
- A support bundle that identifies the project, product, table or tournament, and request id.
Requirements
- A Console project.
- Approved read surface for the product or table you want to show.
- No product API key or management token in the browser source URL.
- Future scopes: likely
embeds:reador a narrower overlay/read scope once promoted.
Recommended shape
Keep the overlay read-only and boring:
- Your server loads approved public-safe state from PokerWorks.
- Your server renders a small browser page for OBS.
- The browser page receives only display data.
- Any player-capable link opens a separate PokerWorks launch flow.
Do not put product keys, management tokens, launch secrets, or raw player identifiers into the OBS URL.
Data policy
The first public overlay contract should prefer:
- table status
- tournament status
- blind level / next break
- remaining player count when public
- public result summaries
- fairness or request ids useful for support
It should avoid:
- private hole cards
- raw internal player ids
- unpublished hand histories
- write actions
- seating controls
Current limitation
Until the external read contract is promoted, this recipe is a template for first-party or approved operator builds, not a copy-paste public API guide. Use it to design the overlay and confirm what data you need; use Support to ask about closed-beta access.