Workflows JSON Import/Export
Overview
Using JSON import and export within workflows, users can easily transfer and edit JSON schemas, making transporting Workflows across or within Orgs seamless.
How to Import JSON
Follow these steps to import a JSON file:
Open the workflow in the Workflow builder.
In the top right, click the three-dot menu.
Select Import JSON.
4. Choose the JSON file to import from your device.
5. Confirm the import in the dialog that appears.
The workflow that was present previously, will be replaced with the contents of the file. If the imported JSON file has an invalid structure, the import stops and an error message is displayed.
Milestones, loop sub-workflows, and other peripheral elements of the workflow are included in the import and export.
How to Export JSON
Follow these steps to export a JSON file:
Open the workflow in the Workflow builder.
In the top right, click the three-dot menu.
Select Export JSON.
A JSON file downloads automatically. The exported file contains the current state of the workflow.
Editing the Schema
Export the workflow first, then edit that file. The export is the workflow as it is now, so your changes start from a complete schema.
Export the JSON file.
Open the downloaded JSON file.
Change the parts of the schema you need, then save the file.
Open the workflow you want to update.
Select Import JSON from the three-dot menu, choose the edited file, and confirm the import.
What you can change
Nodes — The steps on the canvas. The entry name is the step’s key, and name is the label in the builder. settings is that step’s configuration, such as a broadcast subject or a ticket title. A loop or sub-workflow stores the steps inside it under subgraph.
Edges — The paths between steps. from and to must be step keys in nodes. condition_groups decides when a path runs. is_else is the path taken when those conditions do not match.
Start_node — The key of the step the workflow runs first. It must be a key in nodes.
Metadata — name and description are the workflow name and description. retries is how many times the workflow retries. retry_time is how long it waits between retries.
The workflow that is open is replaced with the contents of the file. If the edited JSON file has an invalid structure, the import stops and an error message is displayed.
Handling References
When you import JSON, references are checked; a valid reference is updated successfully, but if a reference is missing, such as a cross-organization import that points to an item or a user that is not in the destination organization, a warning is shown.