Core Concepts
Understanding these concepts will help you get the most out of HubSpot Deploy.
Workspace
A workspace is a shared environment for a team. Everything in HubSpot Deploy — connections, backups, comparisons, and deployments — belongs to a workspace.
- You can be a member of multiple workspaces
- Each workspace has its own set of connections and backups
- Members are invited by email and assigned a role (admin or member)
See Workspaces for details on roles and permissions.
Connection
A connection is an authenticated link to an external service — either a HubSpot portal or a GitHub repository.
| Connection type | What it provides |
|---|---|
| HubSpot portal | Access to read and write metadata from a specific portal |
| GitHub repository | A target for backup commits and a source for comparisons |
Connections are scoped to a workspace. Only workspace admins can create or delete connections.
Metadata
Metadata is the configuration data in HubSpot — the objects, properties, pipelines, workflows, and other settings that define how your portal works. HubSpot Deploy treats this metadata like source code: it can be versioned, compared, and deployed.
See Metadata Types for the full list of supported types.
Backup
A backup is a scheduled job that exports your HubSpot metadata and commits it to a Git repository branch. Each backup run creates a new Git commit with a snapshot of your portal's metadata at that point in time.
Backups run on a configurable schedule: hourly, daily, or weekly.
Comparison
A comparison is a diff between two metadata sources. You can compare:
- HubSpot portal ↔ HubSpot portal
- HubSpot portal ↔ Git repository
- Git repository ↔ Git repository
Comparisons are computed asynchronously and show changes at the field level.
Deployment
A deployment applies metadata changes from a source to a target HubSpot portal. Before a deployment runs, you review the diff to confirm exactly what will change. Every deployment is logged for audit purposes.
Deployments modify live HubSpot data. Always review the diff carefully before confirming.
Sync Task
A sync task is a background job that processes a backup, comparison, or deployment. Tasks are queued and processed by workers. You can monitor task status in real time from the relevant screen.