Schema Reference¶
Toolbox-NXG stores subreddit settings and user data in Reddit wiki pages as versioned JSON. Third-party applications can read and write this data to integrate with Toolbox features.
Wiki page paths¶
All Toolbox-NXG data lives in subreddit wikis under the toolbox-nxg/ path prefix (NXG layout) alongside legacy pages (classic layout). The in-memory model is always the NXG format; classic pages are maintained as compatibility mirrors for 6.x clients.
Data |
NXG wiki page |
Classic wiki page |
|---|---|---|
Subreddit config (removal reasons, macros, ban macros, etc.) |
|
|
Usernotes |
|
|
|
(embedded in |
|
|
(none — NXG-only) |
|
Subreddit notes index (classic: “personal notes”) |
|
|
Subreddit note content |
|
|
All pages are restricted to moderator-only access by wiki page settings (permlevel: 2).
Interoperability notes¶
NXG always reads both layouts. On first access for a subreddit, NXG up-converts any existing classic data to the NXG format. Subsequent accesses reconcile-merge classic-page edits (made by 6.x clients) back into the NXG data.
Write to the classic layout when in doubt. Third-party tools that need to write data and aren’t sure whether a subreddit is migrated to NXG should write to the classic layout (toolbox, usernotes). NXG will reconcile those writes into its own layout on the next access.
Do not create shard pages without updating the manifest. The usernotes NXG layout uses a manifest-plus-shards design. If you create new shard pages without updating the manifest, NXG will never read them.
Preserve unknown fields. New schema versions may add fields. When round-tripping a config or usernotes blob, write back any fields you did not recognize rather than silently dropping them.
Getting help¶
If you have questions about integrating with Toolbox-NXG data formats, please open an issue on GitHub or post to /r/toolbox_nxg.