Deploy sandbox changes to production

Before you get started

Understand requirements

• You must be a Super Admin to create a sandbox and deploy changes to production.
• You must create a standard sandbox to use the deploy to production feature. If you have an existing legacy sandbox, you'll need to create a new standard sandbox.

Limitations & considerations

• You'll have access to one additional sandbox (standard sandbox) in your account during the beta.
• Learn more about which objects and assets will be deployed.

Sandbox best practices

Sandboxes allow users to innovate safely outside of their production accounts. It’s recommended to define a development strategy, and consider the following aspects to ensure reliable testing in sandboxes:

• What’s the purpose of the sandbox? (e.g., active development, integration testing, training).
• Who needs access? (e.g., consider limiting conflicts that can affect testing reliability).
• Is there a need for more sandboxes to support various use cases?
• What's the best way to create and manage sandboxes to support development needs?

Clearly defining these aspects will aid reliable testing, and deployments of supported assets to production, while accommodating other use cases.

Below are examples of different purposes of sandboxes, users who should get access, and creation strategies to ensure reliable testing and development:

Create a standard sandbox

To use the deploy to production feature, you must first create a standard sandbox. To create the sandbox:

1. In your HubSpot account, click the settings settings icon in the top navigation bar.
2. In the left sidebar menu, select Sandboxes.
3. Click Create sandbox.
   
   
4. In the right panel, under Sandbox name, enter the name of the sandbox.
5. Under Sandbox setup, select what to copy from your production account to the sandbox:
   • The Copy production assets checkbox will be selected by default as the sandbox must mimic your production account.
   • Select the Copy 5,000 contacts and associated records checkbox to copy your 5,000 most recently updated contacts, and up to 100 of their associated deals, companies, and tickets (per contact).

Please note: you can copy 5,000 contacts and associated records when building your standard sandbox. If you don't copy records during the sandbox build, you can export and import test records to your sandbox at a later date.

6. Click Create standard sandbox.
   
   
7. The process to create the sandbox may take a few hours, depending on how many assets, production plan features, and Super Admins need to be copied from your production account.
8. The creation status will be displayed on the Activity Log tab, under the Status column.
9. Once created, the status will update.
   
   
10. Click the status next to the sandbox to view the creation details. 
    • Click the Failed assets tab to see any failed assets and the error details.
    • Click the Successful assets tab to see a list of created assets.
      
      

Access the standard sandbox

All standard sandbox account users can access a sandbox from their main account menu:

1. In your HubSpot account, click your account name in the upper right. 
2. Hover over your account name to see a list of your recent accounts. 
3. In the dropdown menu, click the name of the sandbox you want to access.
   
   
4. A banner will display at the top of the window, showing that you're in the standard sandbox account.

Super Admins can also access a sandbox from account settings:

1. In your HubSpot account, click the settings settings icon in the top navigation bar.
2. In the left sidebar menu, select Sandboxes.
3. Click the name of the sandbox you want to access. 
4. To exit a sandbox account, click Go back to my production account at the top of the window.

Set up a production deploy

Once you have made your changes in your sandbox, you can deploy them to your production account. To set up a production deploy:

1. In your HubSpot account, click the settings settings icon in the top navigation bar.
2. In the left sidebar menu, select Sandboxes.
3. Hover over the sandbox, click Actions, then select Set up a deploy.
   • In the Available asset types column, select the assets you want to deploy. If you're deploying objects, next to the assets, click Select configuration

1. • Select the checkbox next to each change that's eligible to be deployed. If you're deploying objects, this will be in the right panel, and you must click Save selection.
     
     

     Please note: if you create a new object in the sandbox, you must deploy all changes.

2. Click Next.
3. Any connections will display at the Connections step. Connections are other assets in your account used by your selected assets.
   
   • Click View object configurations in the Name column to view what'll be deployed, based on the connection.
   • Click x selected assets in the Used by column to view the connections.

   • To include the configuration in the deployment, click the Add x connections to my deploy to continue checkbox, then click Next.

4. Any conflicts will be automatically detected. Click Next.
5. In the Deploy name field, enter a name for your deploy. In the Description field, enter a description. Click Next.
6. Review your production deployment. When you're ready, click Deploy to Production.
7. Click Deploy to production to confirm.
   
   
8. The deployment will be added to the Production deploys. The Status column will display the progress. Once a deployment has started, it can't be canceled.
9. Once the deployment is complete, the status will update to x changes deployed.

• Please note: if your deployment fails, try the deployment again, or contact support.

15. Click the deployment name or x changes deployed to view the deployment details.