Skip to main content

Import / Export

Move workspace configuration around. Export captures assistants, workflows, knowledge, and other configuration. Choose JSON for configuration only, or ZIP for a single archive that also includes file contents. Import restores whichever format you downloaded.

Go to Settings → Workspace → Export.

Export​

Click Export. The dialog offers three actions immediately:

  • Export as JSON — configuration only. File contents are not included. Useful for version control and sharing setup without attachments.
  • Export as ZIP — the same configuration plus files, in one archive. Use this when you need a complete backup or to copy files into another workspace.
  • Send to Workspace — copies the ZIP (configuration plus files) into another workspace you can access.

CLI:

yarn gr workspaces export -w $UUID --env prod
yarn gr workspaces export -w $UUID --env prod --format zip --output export.zip

Useful for:

  • Backups — Snapshot before a major reconfiguration so you can roll back.
  • Migration — Copy configuration into a new or sister workspace.
  • Debugging — Share configuration with support when troubleshooting.
  • Templating — Export a "golden" workspace and import it as the starting point for new ones.

The export captures the configuration tree (assistants, workflows, abilities, data types, templates). It does not capture chats, members, or other operational data — those stay in the source workspace.

If the export fails with a conflict error, an evaluation setup in your workspace belongs to a workflow that has been archived. Archived workflows are left out of the export, and the evaluation cannot be exported without its workflow — so the export stops rather than hand you a file that would lose the scenarios on import. The error names the workflow by ID: unarchive it from Workflows → Archived, then export again.

Import​

Click Import and pick a previously exported JSON or ZIP file. ZIP restores files; JSON does not. The configuration is applied to the current workspace.

CLI:

yarn gr workspaces import -w $UUID --env dev --file export.json --create-all
yarn gr workspaces import -w $UUID --env dev --file export.zip --create-all

Warning Always Export first before importing into a workspace that already has configuration, and read the preview before applying. Importing an export a second time into the same workspace is supported, but only for what the import can match: a matched Workflow, Task, rule, Form, or File is updated in place, while anything it cannot match is created again. Skipping the preview after a partial or failed first import is how duplicate Workflows and rules appear. If an import into a new workspace fails, retry in a clean workspace.

A second import into the same workspace keeps what you have set up by hand:

  • A webhook rule's endpoint, signing secret, and on/off switch are never overwritten. A newly imported webhook rule still arrives switched off.
  • A routine's audience (the member filter or Member it targets) changes only when the export names one that exists in this workspace.
  • Rules that were dropped for a missing phone number, inbox, or Member are listed once. Rebuilding them from the warning cards (see below) never creates a second copy on a later import.
  • Calendar availability schedules, workflow notes, roles' permissions, and file sharing settings are left as they are in this workspace.

What a second import does not do: it does not carry template edits into a rule you rebuilt from the warning cards, and it does not skip writing when nothing has changed.

Import is best used on:

  • Fresh workspaces — Apply a template to a new workspace before any real configuration is built up.
  • Existing workspaces after a careful preview — Explicitly map source items to the intended destination items and review everything marked Create new. Import is not a general rollback mechanism.

Finish a cloned workspace​

A successful import means the portable configuration was created. It does not mean the workspace is ready to communicate. Phone carrier assignments, inbox credentials, Members, and app connections belong to the destination and must be provisioned there.

After an import, return to Settings → Workspace → Export and resolve the warning cards at the top of the page:

  • Setup items need attention lists live phone, inbox, Workflow, inbound routine webhook, and app/EHR connection binding gaps. Each item links directly to the affected setting. It disappears after the setting is fixed — for an inbound routine webhook, once the vendor's signed delivery has been received; for an app/EHR connection, once it is connected or re-authorized.
  • Rules need reconnection lists EventRules omitted because a source phone, inbox, or Member could not safely carry into the destination. Provision or enroll the replacement, select it once for the group, and rebuild the rules. The rebuild preserves each rule's conditions, templates, ordering, and active state.
  • Rejected definitions lists EventRules the import could not write at all — an invalid condition, or a Journey scope that did not resolve. There is nothing to reconnect. Correct the rule in the source workspace and import again.

Before handoff, exercise every channel the clone will use: inbound and outbound calls, SMS, email, routines, notifications, and any public Site flow. Confirm both warning cards are clear. A screen that loads proves the configuration can be displayed; it does not prove the channel is provisioned or routed.

Tips​

  • Export regularly. Treat exports like database backups — keep periodic snapshots, especially before risky changes.
  • Version-control critical configuration. Commit your export JSON to a git repo so you have history and diff-ability. Use ZIP when you also need files.
  • Test imports on a scratch workspace. Before importing into production, verify the file imports cleanly into a sandbox workspace.

For developers​