Configuration Sandbox

The Configuration Sandbox lets admins preview changes to pipelines, automations, custom fields, and other settings without affecting live users. Changes are promoted to production only when you're ready.

How It Works

When you create a sandbox, every configuration table is cloned. You can then edit pipelines, automations, SLA policies, and other settings freely. Live users continue to see the original configuration — your sandbox edits are invisible to them until you promote.

What's included in the sandbox

The sandbox covers configuration tables only — not data:

This means you always test config changes against real data — you see exactly how a new pipeline stage or automation will behave in production.

Who can see the sandbox

Only the admin who clicks Enter Sandbox sees the sandbox configuration. The sandbox is tied to a browser cookie, so:

• Other admins, managers, and reps see live config at all times
• Opening a different browser or incognito window defaults to live
• The admin can exit sandbox mode at any time without losing changes

Getting Started

Creating a sandbox

1. Go to Settings → Sandbox
2. Click Create Sandbox
3. The system clones all live configuration tables (takes a few seconds)
4. Click Enter Sandbox to switch your view

A banner appears at the top of the screen confirming you're in sandbox mode. The sidebar also shows a SANDBOX badge next to your organization name.

Editing in sandbox mode

Once in sandbox mode, any configuration change you make applies to the sandbox copy:

• Add or rename pipeline stages
• Create or modify automations
• Adjust SLA policies and case queue routing
• Add custom fields or rearrange field layouts

Data operations (creating opportunities, logging calls, etc.) always apply to the shared live data regardless of mode.

Reviewing changes

Navigate to Settings → Sandbox to see a diff summary showing added and removed items per configuration table. Use this to verify your changes before promoting.

Promoting to Live

When you're satisfied with the sandbox configuration:

1. Go to Settings → Sandbox
2. Review the diff summary
3. Click Promote to Live

This atomically swaps the sandbox configuration into production:

• All users immediately see the new configuration
• The old live configuration is preserved as Previous for rollback
• The sandbox is cleared (you can create a new one later)

A database snapshot is automatically taken before each promotion as an additional safety net.

Automations in sandbox mode

Sandbox automations execute in dry-run mode. When a CRM event fires:

• Live automations execute normally (send emails, update fields, create tasks)
• Sandbox automations log what would happen without performing side effects

This lets you verify trigger conditions and action sequences without affecting real records. Check the automation run history — dry-run executions are clearly marked.

Rolling Back

If a promoted configuration causes issues:

1. Go to Settings → Sandbox
2. Click Rollback to Previous
3. The previous configuration is restored as live immediately

Rollback is only available when a previous configuration exists (i.e., after at least one promotion).

Discarding a Sandbox

To discard a sandbox without promoting:

1. Go to Settings → Sandbox
2. Click Discard Sandbox

All sandbox configuration rows are deleted. Live configuration is unaffected.

API Reference

All sandbox endpoints require the admin or super_admin role.

Get sandbox status

GET /api/v1/admin/sandbox

Returns the current state of live, sandbox, and previous environments.

Create sandbox

POST /api/v1/admin/sandbox

Clones all live config into a new sandbox. Returns row counts per table.

Toggle sandbox mode

POST /api/v1/admin/sandbox/toggle
Content-Type: application/json

{ "enable": true }

Sets or removes the sandbox cookie for the current session.

View diff

GET /api/v1/admin/sandbox/diff

Returns added/removed counts per config table comparing sandbox to live.

Promote sandbox

POST /api/v1/admin/sandbox/promote

Atomically swaps sandbox → live and live → previous.

Rollback

POST /api/v1/admin/sandbox/rollback

Restores the previous configuration as live.

Discard sandbox

DELETE /api/v1/admin/sandbox

Deletes all sandbox config rows without affecting live.

Best Practices

• Review the diff before promoting — verify you're only changing what you intend
• Test automations — check the dry-run history in sandbox to confirm triggers fire correctly
• Coordinate with your team — let other admins know before promoting, since it affects everyone
• Don't leave sandboxes open indefinitely — live config changes made after sandbox creation won't be reflected in the sandbox copy
• Use rollback quickly — rollback restores the config from before your last promotion; a second promotion overwrites the rollback point