Quick reference
| I need to… | Action |
|---|---|
| Publish a new version | Click Publish → add description |
| Promote to Pre-release | Deployments > Environments → Options → Promote to Pre-release |
| Promote to Live | Deployments > Environments → Options → Promote to Live |
| Rollback | Find the last good version → Promote to Live |
| Compare versions | Select two versions → Compare |
| View history | Deployments > Environments |
Publishing
Publish a version when you’ve made changes in Sandbox and want to create a checkpoint, test in a clean environment, or prepare for promotion.- Make and test your changes in Sandbox
- Click Publish in the top right
- Add a clear version description
- Click Publish
Connected Knowledge content is synced separately. Sync sources before publishing to ensure the latest content is available.
Promoting
To Pre-release
- Go to Deployments > Environments
- Click the Options Menu next to the version
- Select Promote to Pre-release
To Live
- Go to the Pre-release tab in Deployments > Environments
- Click Options → Promote to Live
- Confirm by checking the box and clicking Promote
Comparing versions
- Go to Deployments > Environments
- Select two versions and click Compare
- Review the diff:
- Green – additions
- Red – deletions
- Blue – edits
Rolling back
Rollback when a new version has critical bugs, performance degrades, or customer complaints spike. Rollback is just promoting an older version:- Go to Deployments > Environments
- Find the last known good version
- Promote it to Live
Deployment workflows
Standard deployment
- Develop and test in Sandbox
- Publish with descriptive notes
- Promote to Pre-release → validate
- Promote to Live → monitor closely
Hotfix
- Reproduce the issue in Sandbox
- Fix, test, publish
- Promote through Pre-release briefly, then to Live
- Monitor closely
Seasonal updates
- Apply seasonal changes in Sandbox (hours, policies, etc.)
- Publish, promote, and schedule for the right date
- Revert after the season ends
Best practices
- Publish regularly – don’t accumulate too many changes in a single version
- Run test sets before promoting – catch regressions early
- Monitor after promotion – watch the first 30 minutes closely, check metrics for 24 hours
- Be ready to rollback – know which version to revert to before promoting
- Use consistent descriptions – consider tags like
[HOTFIX],[FEATURE],[SEASONAL]
Automate with the Agents API
If agent promotions belong inside a wider release pipeline, the same publish / promote / rollback actions are available over HTTP.Automate the deployment pipeline via the Agents API
Automate the deployment pipeline via the Agents API
The Agents API exposes publish, promote, and rollback so the same steps can run from CI alongside backend services or infrastructure.A typical CI job publishes to Sandbox, runs your test suite, promotes to Pre-release on success, and blocks promotion to Live behind a manual approval gate.
Related pages
- Environments and versions – technical reference
- Version diffs – comparing changes
- Project history – viewing past versions
- Test suite – automated validation
- Deployments endpoints – publish, promote, and rollback from code

