Glossary
Definitions of terms you'll encounter in the docs and dashboard.
Plain-language definitions of terms used across the platform. Click any entry to expand it.
A — F
API key
A secret token that authenticates requests to the platform's API. Keys are scoped to a workspace and inherit the permissions of whoever created them. See Permissions.
Automation
A piece of code that runs in response to a trigger — for example, a deploy completing or a comment being posted. See Automations.
Build
The process of turning your source code into deployable output. Each build produces an artefact, which is then promoted to a deploy.
Custom domain
Your own domain (like docs.yourcompany.com) attached to a project, in place of the auto-generated subdomain. See Custom domains.
Deploy
A live version of your project, served from a URL. Each successful build can be promoted to a deploy. The current production deploy is the one served at your primary URL.
Environment
The set of variables, secrets, and configuration that applies when your project runs. Most projects have at least two environments: production and preview.
G — P
Guest
A workspace role that can view published deploys but nothing else. Guests don't count towards your member limit. See Permissions.
Member
Anyone with access to a workspace. Each member has a role that determines what they can do. Different from a guest, which is a special role that doesn't count towards your member limit.
Preview deploy
A deploy created automatically for a branch or pull request, served at a unique URL. Used to test changes before they reach production.
Project
A deployable unit. Each project has its own source, builds, deploys, environment, and domains. Projects are isolated from each other within a workspace. See Workspaces and projects.
R — Z
Role
A workspace-level designation that determines what a member can do. Roles are: Guest, Viewer, Reviewer, Editor, and Admin. See Permissions.
Source
The repository or upload that produces your project's builds. A project has exactly one source.
SSO
Single sign-on. Lets your team authenticate with your identity provider (Okta, Azure AD, etc.) instead of platform-specific credentials. Available on Business and Enterprise plans.
Trigger
The event that starts an automation — for example, deploy.succeeded or webhook.received. See Automations.
Workspace
The top-level container for a team's work. Owns billing, members, and projects. See Workspaces and projects.
A term missing? Suggest it in the community — we update this glossary regularly.
Was this helpful?