Skip to main content

Import & Export

The Widget Builder allows you to export widgets as JSON files and import them into other accounts. This is useful for transferring widget configurations between environments or sharing widgets with colleagues.

Exporting a Widget​

You can export any widget (custom or built-in) directly from the widget list.

  1. Navigate to Custom Widgets (or Built-In Widgets).
  2. Hover over the widget card to reveal the action buttons.
  3. Click the Download icon button.

A JSON file will be downloaded to your computer automatically. The file name follows the pattern:

<widgettitle>_wb_<timestamp>.json

For example: mymenuwidget_wb_2025-01-15_14-30-00.json

What is included in the export?​

The exported JSON file contains the complete widget configuration:

  • Template (HTML/Handlebars markup)
  • CSS styling
  • Form fields (widget settings definition)
  • Variables (custom variable definitions and defaults)
  • Translations (all language strings)
  • API configuration (URL, method, headers, body)
  • Metadata (export date, Widget Builder version, source URL)

What is NOT included?​

  • Widget icon -- the icon image is not part of the export file.
  • API Proxy credentials -- API request IDs reference server-side proxy configurations that cannot be transferred. You will need to reconfigure the API Proxy on the target account.

Importing a Widget​

You can import one or more widget JSON files into your account.

  1. Navigate to Custom Widgets.
  2. Click the Import button in the top-right corner of the page.
  3. In the import dialog, click Select file and choose one or more .json files.
  4. Review the listed widgets. Each valid widget shows an info message with its name. Invalid files show an error message.
  5. Click Import to create the widgets.

What happens after import?​

  • Each imported widget is created as a new Custom Widget.
  • The imported widget is always set to Inactive (draft state) -- you must activate it manually.
  • The original widget's id and guid are discarded; the imported widget gets new identifiers.
  • A success notification confirms the import.

Limitations​

LimitationDetails
Icons not transferredWidget icons are not included in the export. Upload a new icon after importing.
API Proxy referencesIf the original widget used the API Proxy, the proxy configuration is not transferred. Set up the API Proxy again on the target account.
Always inactiveImported widgets are created as inactive drafts. Activate them manually after reviewing the configuration.
File formatOnly .json files exported by the Widget Builder are accepted. The file must contain a _meta.type field set to "widget".