Articles in this section

Download or install an integration ZIP file

You can download a custom integration as a ZIP file and install that file in another account, so a team can share an integration one of them built, keep a copy outside integrator.io, or reproduce an integration for another customer. The ZIP holds the integration's flows, exports, imports, mappings, APIs, tools, and other configuration, but no connection credentials — whoever installs it configures the connections. This article shows you how to download an integration, what the file contains, how to install one you've received, and what to do when an install fails.

Integration apps are licensed products and can't be downloaded or shared. To copy one, use Clone integration instead; see Clone an integration.

Prerequisites: You must have Manage all permissions. See Manage user roles & permissions to an account.

Download an integration

  1. Go to Home home-icon.png.
  2. Select the integration's Actions elipses-button.png > Download integration.

Your browser saves <Integration>.zip to its default download location. You can rename the file before sharing it.

What the ZIP contains

  • Flows, exports, imports, lookups, and scripts
  • APIs and tools
  • Mappings, transformations, filters, and hooks
  • Branching and routing logic
  • Flow groups and group assignments
  • The readme
  • Aliases
  • The configuration — name, description, and retention — of any topics the integration uses, but not their messages
  • Lookup cache data, under the same conditions as a clone; see What a clone carries over

It doesn't contain connection credentials, flow schedules, or next run times.

Install an integration ZIP file

Installing creates a new copy of the integration in your account with no link to the original. You can install a ZIP from any environment into any environment you can access; the connections are configured for the environment you install into. Installing always creates new topics, even in the same account and environment — unlike a clone, an install never reuses an existing topic.

  1. Go to Home home-icon.png.
  2. At the top right, select Upload.
  3. Select Select a file and choose the ZIP, or drop the file onto the panel. The file must be a .zip of 1 MB or less.
  4. Review the components listed, and then select Install integration.
  5. If a disclaimer appears, read it and select Proceed.
  6. For each connection, select Configure, enter its details, and test it. For an application's specific settings, see Connector solutions.

When every connection is configured, the integration appears on the Home page and opens with its flows listed, ready to turn on.

Store integrations in a version control system

A downloaded ZIP is also a convenient way to keep integrations in GitHub, GitLab, or another version control system — for a backup outside integrator.io, for a versioned history, or so teammates can review an integration without access to your account. Extract the ZIP and commit its contents to a branch; after a review, make the changes in integrator.io, test them there, download the integration again, and commit the new version. Keep integrator.io as the source of truth: it's the only place you can test that a change works. To automate the download, use the integrator.io REST API.

Troubleshoot an install

Looks like the uploaded zip is corrupted

Symptom. The message Looks like the uploaded zip is corrupted. Please contact Celigo support if the issue persists. appears when you preview or install a Marketplace template, or install an integration from an uploaded ZIP. It never appears when you save a flow, export, import, or connection.

Cause. integrator.io couldn't read the package.

  • For a Marketplace template, the published copy for your region can't be read. Nothing in your account or browser causes it, retrying doesn't help, and every user in your region sees the same message for that template.
  • For an uploaded ZIP, the file itself can't be read — usually because it was renamed, edited, or damaged after it was downloaded.

Resolution.

  • Marketplace template: contact Celigo Support and name the template. While it's being fixed, you can still get the integration two ways: if you already have the same template installed in your account, clone that integration (a clone packages your installed copy, not the Marketplace file); or download the integration ZIP from an account or region where the template installs, and install it with Upload.
  • Uploaded ZIP: download the integration again from the source integration and upload the fresh file.

An install fails partway through

Symptom. An error stops the installation and a partial integration remains in your account.

Resolution. Delete the partial integration with the DELETE /v1/integrations/{id} API call, and then install again. If the ZIP came from a Marketplace template, install the template from the Marketplace instead.