Share or Save a Flow Definition

Exporting a flow lets you save or share your work as a JSON file. This is useful when you want to back up a specific version, move a flow to another workspace, or share a template with another team.

In this guide, you’ll learn how to export a flow from the editor, download the JSON definition, and understand what the export includes (and what you may need to recreate in another workspace).

Export a flow to JSON (backup or share)

If you just need the fast path, follow this:

  1. Open the flow in the flow editor
  2. Open the ☰ menu in the top-right
  3. Click Export Definition and confirm export options (if shown)
  4. Save the downloaded JSON in a safe place (and name it clearly)

You’re done. You now have a portable flow definition you can store, version, or share.

Step-by-Step Process

1
Open the flow you want to export

  1. Log in to your RapidPro.app workspace.
  2. Go to the Flows tab.
  3. Click the flow you want to export to open it in the flow editor.

[CAPTURE: Flows list with a flow selected and the flow editor open.]

💡
Tip: Export before major edits so you always have a “known good” version you can restore or share.

2
Open the flow menu

  1. In the flow editor, locate the menu icon (☰) in the top-right corner.
  2. Click the ☰ icon to open the flow options menu.

[CAPTURE: Flow editor showing the ☰ menu icon highlighted in the top-right.]

💡
Tip: If you don’t see the menu, confirm you’re in the editor view (not the Flows list).

3
Export the flow definition (JSON)

  1. In the ☰ menu dropdown, select Export Definition.
  2. If prompted, choose what to include in the export (for example, export options or selection choices depending on your UI).
  3. Click Export.

[CAPTURE: ☰ menu dropdown showing “Export Definition” selected, and an export modal with an “Export” button at the bottom.]

After exporting:

  • A JSON file downloads to your computer.
  • You can store it as a backup or share it with someone who can import it into another workspace.
⚙️
Technical Detail: The exported JSON is the flow “definition” (structure, nodes, rules, and configuration). It’s designed for portability and version control.

💡
Tip: Use a consistent naming pattern for exported files, for example: FlowName_v1_2025-12-17.json.

⚠️
Warning: Treat exported files as sensitive if your flow contains URLs, identifiers, or integration endpoints. Store exports in a secure location and share them only with trusted teammates.

4
Prepare the flow for another workspace (optional but recommended)

  1. If you plan to import the flow elsewhere, list any dependencies your flow uses, such as:
    • Contact fields
    • Groups
    • Channels and channel-specific behaviors
    • Integrations (webhooks, events, tokens)
  2. Share those requirements with the person importing the flow (or recreate them first in the destination workspace).
  3. After import, run a simulator test to confirm everything behaves as expected.

[CAPTURE: A simple checklist view or note showing “required fields/groups” for a flow, or the simulator confirming a successful test after import.]

💡
Tip: When sharing a flow between teams, share the required fields/groups list alongside the JSON so the imported flow works immediately.

Common Issues & Quick Fixes

Problem: I don’t see “Export Definition” in the menu.

Fix: Confirm you are inside the flow editor (not the Flows list). Check your role—export may require Editor or Admin permissions. If your UI uses different wording, look for Export, Download, or Export JSON.

Problem: Nothing downloads after I click Export.

Fix: Check your browser’s download bar or downloads folder. Make sure your browser isn’t blocking downloads/pop-ups. Try exporting again and watch for a confirmation or download indicator. If you’re on a restricted network, try another browser or allow downloads for the site.

Problem: I exported the flow but can’t use it in another workspace.

Fix: Confirm the destination workspace supports flow import and you have permission to import. If your flow depends on fields, groups, channels, or integrations that don’t exist in the destination workspace, recreate them or update the flow after import.

💡
Tip: When sharing flows between teams, also share your required contact fields, groups, and any integration settings so the flow runs correctly after import.