When you create an authentication token, you can pick a use case from the dropdown. This preselects the scopes the token needs, so you don't have to work out which permissions each feature requires. Here's what each option is for.
If none of these fit, or you want to hand-pick scopes, choose Custom. Custom scopes are available on Professional and Enterprise plans.
Not sure how to create a token? Start with Authentication token creation.
Activity feed
Pull the activity feed for a styleguide over the REST API. This is the same stream of page edits, status changes and releases you see on the dashboard, so you can pipe it into Slack, a data warehouse or your own reporting.
Scopes: activity:read
Needs access to the zeroheight API, which is included on Professional and Enterprise plans.
Measure adoption
Authenticate the @zeroheight/adoption-cli so it can send package version, component usage and colour usage data from your repos to zeroheight. Run it locally to get started, then drop it into CI so your adoption data stays up to date.
Scopes: design_system_usage:read, design_system_usage:write, design_system_package_usage:write, repository:read
Adoption features are part of our Enterprise Scale plan. If you'd like to try them, get in touch.
- Introduction to measuring design system adoption
- Package version monitoring
- Using the Adoption CLI as part of a CI pipeline
- @zeroheight/adoption-cli on npm
Style Dictionary exports
Use this when you want to fetch a private Style Dictionary export URL from a build script or pipeline. Public export URLs don't need a token at all, but private ones need a client ID and access token sent as headers on every request.
Scopes: token_set:read
Available on all plans with design tokens.
- Exporting and integrating design tokens into developer pipelines
- Getting started with the zeroheight API
Storybook addon
The @zeroheight/storybook-addon shows your zeroheight documentation in a tab inside Storybook, so developers can read the guidance for a component without leaving their tools. The addon reads page content through the API, so the token only needs to read pages.
Scopes: page:read
Needs access to the zeroheight API, which is included on Professional and Enterprise plans.
Custom
Pick your own combination of scopes. This is the option to use for anything built directly against the REST API, for example syncing page statuses with a project management tool, or reading styleguide and release data into another system.
Each scope is described next to its checkbox when you create the token. A good rule of thumb: only grant what the integration actually calls, and create a separate token per integration so you can revoke one without breaking the others.
FAQ
Can I change the scopes on a token later?
No - to change scopes, create a new token with the scopes you need and revoke the old one. If you only need a fresh access token with the same scopes, use the refresh option on the existing token instead.
Why can't I see some of these use cases?
The dropdown only shows options your plan includes. Measure adoption, Custom, MCP and Storybook addon depend on your plan or feature access.
Where do I manage existing tokens?
In the Developers section of your organization or workspace settings. Tokens belong to the team, not the person who created them, so they keep working if that person leaves.