Articles in this section

Integrations overview

An integration is the container that holds everything integrator.io needs for one business process: the flows that move and transform data, the connections those flows use, and any APIs, tools, topics, lookup caches, and files that support them. Every integration appears on the Home page, and opening one gives you a single place to build, run, monitor, and share its contents. This article explains the kinds of integrations you'll see, what an integration contains, and where to find each part of it on the integration page, with links to the articles that cover each task in full.

Custom integrations and integration apps

integrator.io shows two kinds of integrations on the Home page:

  • Custom integration — An integration you build yourself. You create the integration, add flows, APIs, tools, and topics to it, and connect any application with an accessible API. Custom integrations are the right choice for proprietary systems, niche tools, or business logic that a prebuilt product doesn't cover. Most of the articles in this section describe custom integrations.
  • Integration app — A prebuilt, licensed product that Celigo or a partner maintains, installed from the Marketplace. It arrives with its flows, mappings, and settings already configured for a specific pair of applications, and it's updated and supported as a product. Integration apps are managed through their own settings and can't be downloaded or shared as files; see Jump-start integrations with templates and apps.

Every flow belongs to an integration. Flows that were created before integrations became required were moved into an integration named Standalone flows, created once per account; it's an ordinary custom integration, so you can open it, move its flows into other integrations, or delete it. See Move a flow to another integration.

What an integration contains

An integration sits at the top of a hierarchy, and each level below it is where you control a narrower part of the data movement:

  • Integration — The container, for example Shopify to NetSuite sync.
  • Flows — Each flow automates one path through the data, for example Order sync or Inventory update. See Create a flow.
  • Steps — The exports, listeners, lookups, and imports inside a flow that retrieve, enrich, and write records.
  • Connections — The authenticated credentials that steps use to reach each application. A connection can be shared by several flows and several integrations; see Review integration connections.

An integration can also contain APIs built in API builder, tools built in Tool builder, topics that flows publish to and listen on, lookup caches, a folder in Celigo Storage, and aliases that scripts use to reference its resources. A topic can be registered to more than one integration.

You can organize the flows and APIs in a large integration into named groups; see Organize flows and APIs into groups.

Integrations on the Home page

Go to Home home-icon.png to see every integration in the current environment, either as tiles or as a sortable, filterable list. Each tile or row shows the integration's status at a glance — Success, a count of open errors, or a count of offline connections — and Actions elipses-button.png offers the integration-level tasks: clone, download, delete, or pin. See Manage integrations on the Home page.

What's on the integration page

Open an integration from the Home page to reach its tabs. Tabs that don't fit in the tab bar appear under More. Clone integration and Delete integration are at the top right of the page.

Tab or button What it's for Where it's documented
Settings Custom settings and forms that flows in the integration read at runtime. JSON settings aren't available for APIs. Customize integration settings
Flows Every flow in the integration: its status, errors, schedule, and mappings, with actions to run, enable, clone, move, or delete it. This tab opens by default. Monitor flows, APIs, tools, and topics in an integration
APIs The APIs registered to the integration and their builder, logs, and management actions. Monitor flows, APIs, tools, and topics in an integration
Tools The tools registered to the integration. Monitor flows, APIs, tools, and topics in an integration
Dashboard Running and completed flow runs for this integration, with their record counts and errors. Monitor flows on the Dashboard
Connections The connections registered to the integration, their online or offline status, and their queue sizes. A red dot on the tab means a connection is offline. Review integration connections
Lookup caches The lookup caches registered to the integration, with each cache's size and last-updated date. Register lookup caches & create aliases
Knowledge bases Searchable collections of your organization's documents that AI agents in the integration can consult for business context, such as policies or product manuals. Create and manage knowledge bases for AI agents
Topics The topics registered to the integration and each topic's message history. Monitor flows, APIs, tools, and topics in an integration
File storage The integration's folder in Celigo Storage, where you can create folders and upload files. Celigo Storage overview
Alerts Who gets an email when a flow has errors, when a connection goes offline, or when a flow runs longer than a limit you set. Set up email notifications for flow errors or offline connections and Set alerts for long-running flows
Audit log Every change made in the integration and its resources during your data retention period. View or download your audit logs
Analytics Charts of successes, errors, ignored records, and processing time over the period you choose. Analyze integration and flow metrics
Users Who can access the integration and at what level, and where to invite more users. Invite users to an integration
Aliases Named aliases for the integration's resources, so scripts can reference them without resource IDs. Aliases aren't available for APIs or tools. Create and manage aliases to reference resources in scripts
Revisions The history of snapshots, pulls, and reverts, for version control and releases. Work with revisions
Admin The integration's name, description, and readme. Create an integration
Clone integration Duplicates the integration and its resources so you can change the copy safely. Clone an integration
Delete integration Removes the integration; you can restore it from the Recycle bin during your data retention period. Delete or restore an integration

Plan your integration

A few habits make integrations easier to run and maintain:

  • Define the goal before you build. Write down the applications to connect, the data that moves between them, and the process you're automating. Name the integration for the systems and the goal, for example Zendesk - Jira: Ticket sync.
  • Start from a Marketplace integration app or template when one fits. They encode patterns that already work for common scenarios, and they're faster to adopt than building the same flows from scratch.
  • Build and test in a separate environment. Clone the integration into a development or sandbox environment, test its flows there, and promote it when it's ready; see Clone an integration and Use multiple environments.
  • Watch the Dashboard after you deploy. Confirm that flows keep completing as expected and resolve errors as they appear; see Monitor flows on the Dashboard.
  • Review Analytics periodically. Error spikes and rising processing time point to where to investigate or simplify; see Analyze integration and flow metrics.
  • Use Integration Lifecycle Management. Snapshots, pulls, and reverts give you a controlled path from development to production and a way back when a change goes wrong; see Integration Lifecycle Management (ILM) overview.