Skip to main content

Quick Start

Get HubSpot Deploy up and running in under 5 minutes.

Prerequisites

  • A HubSpot account with admin access to at least one portal
  • A GitHub account with access to a repository you want to use for backups

Step 1 — Create an account

Sign up at app.hubspotdeploy.com using your email address. No credit card required during the beta period.

Step 2 — Create a workspace

A workspace is a shared environment for your team. After signing in:

  1. Click the workspace switcher in the top navigation bar
  2. Select New Workspace
  3. Give it a name (e.g. "My Team") and confirm

You can create multiple workspaces — for example, one per client or one per project.

Step 3 — Connect a HubSpot portal

  1. Go to Connections in the sidebar
  2. Click Connect Portal
  3. You'll be redirected to HubSpot to authorize access via OAuth
  4. After authorizing, you'll be returned to HubSpot Deploy and the portal will appear in your connections list

HubSpot Deploy will begin retrieving your portal's metadata. This may take a few minutes depending on the size of your portal.

Step 4 — Connect a GitHub repository

  1. Still on the Connections page, click Connect Git
  2. Authorize GitHub access via OAuth
  3. Click Add Repo and select the repository and branch you want to use

Step 5 — Create your first backup

  1. Go to Backups in the sidebar
  2. Click New Backup
  3. Select your HubSpot portal, GitHub repository, and target branch
  4. Choose a schedule (hourly, daily, or weekly)
  5. Click Save

Your first backup will run on the next scheduled interval. You can view the run history from the backup card.

What's next?