Developer API/Migrate from the Overlay SDK
Migrate from the Overlay SDK
Replace the legacy browser script with API routes and the TypeScript SDK.
The legacy /overlay-sdk/v1.js browser script has been removed. Custom
integrations should read explicit API resources and subscribe to their
changes through the gateway.
Resource mapping
| Legacy state | API |
|---|---|
| Event identity and branding | GET /events/{eventId} |
| Match identity, teams, scores, and timing | GET /events/{eventId}/matches/{matchId} |
| Event broadcast configuration | GET /events/{eventId}/broadcast |
| Live playday selection and overlay score | GET /events/{eventId}/playdays/{playdayId} |
| Map reference data | GET /maps |
| Polling for changes | wss://api.strave.gg/v1/gateway |
Use the TypeScript SDK in hosted applications. For a
plain HTML overlay, call the REST endpoints with fetch and reconnect to the
gateway using the documented protocol.
Never publish an organisation API key in a public website. Custom browser sources should run in a controlled production environment such as an OBS profile. Rotate the key immediately if a browser source URL or configuration is shared outside that environment.