First run
- Step 1
Open Developer Integrations and review the currently available scopes.
- Step 2
Create a token only for the operations you need.
- Step 3
Use the examples and data format shown in the dashboard. Keep the cursor when reading events.
- Step 4
Handle interruptions, retries and no new events. Revoke a token you no longer need.
Broadcast example
Your own tool retrieves subsequent events without processing the same history multiple times. The cursor allows you to continue from the last position, and the limited scopes of the token narrow its permissions.
Action and possibilities
Keys with ranges
In Integrations, create a key with separate permissions for LIVE state, events, timer or music queue. We only show the key once. Choose validity of 7, 30 or 90 days; you can revoke it at any time.
Read and cursor
Pass the key in the Authorization: Bearer header. Reading events uses the after cursor, thanks to which the automation does not repeat old messages. The first reading without a cursor starts from the current moment. Reading is limited to the key owner's data.
Example and documentation
Download the OpenAPI 3.1 description and JavaScript sample to your own server, Node-RED or other automation environment. Send one request at a time, recommended every two seconds, with a limit of 60 requests per minute. Do not place the key in public HTML or in the overlay address.
See the interface up close
Click on the illustration to enlarge it. The screenshots show different parts of the setup; the caption explains what to look out for.
When something doesn't work
The request is denied access
Check the token and required scope. Use up-to-date endpoint documentation and the correct request method.
The same events repeat themselves
Store the returned cursor and deduplicate IDs. Don't start each reading from the beginning of the story.