Muxy provides a storage area for developer-defined configuration data that is specific to either an extension or a channel.
Configuration data, like state data, is developer defined. You can define, monitor, and manage whatever configuration data you want to track in real time.
Configuration storage differs from state storage in that it is optimized for long-term storage at the expense of data storage limits. Configuration data is handled in much the same way as state data.
The Muxy server maintains two configuration stores with different scopes.
-
Channel config store: Keeps configuration data for an extension running on a specific channel. A user with the
broadcasteroradminrole can set and modify configuration values for their own channel. The configuration data can be accessed by all viewers of the associated channel. -
Extension config store: Keeps configuration data shared across all instances of an extension on any channel.
Extension-wide configuration can only be set by a caller withadminrole or abackend-authenticated request (that is, a JWT created with knowledge of the extension secret, such as a custom server). The data can be accessed by all admins, broadcasters and viewers.
Each configuration store contains a single JSON-encoded object containing developer-defined key-value pairs.
- Use POST to replace the entire data object in any of the data stores. Pass the new data object in the body of the request.
- Use PATCH to modify specific state values. Pass a JSON object, in JSONPatch format, containing new key-value pairs in the body of the request.
- Successful GET calls return the stored data in the body of the response.
Use the following endpoints to create, manage, and access state data.
| Endpoint | Description | Commands |
|---|---|---|
config | This endpoint provides read-only access to all of the configuration stores. | Use GET to retrieve current values from all configuration stores. |
config/extension | The Extension store keeps configuration data shared across all instances of an extension. | Use POST to create or replace the entire config object in this store. Use GET to retrieve specific configuration values. Use PATCH to modify specific configuration values. |
config/channel | The Channel store keeps configuration data across all extension instances on a given channel. | Use POST to create or replace the entire config object in this store. Use GET to retrieve specific configuration values. Use PATCH to modify specific configuration values. |
Access authorization summary
- A caller with
broadcasterrole can store, modify, and retrieve state only for their own channel.- A caller with
backendoradminrole can store, modify, and retrieve state for any channel.- A caller with
viewerrole can only retrieve state for the channel they are watching.