Articles in this section

Multi-instance flow rules and limitations

This reference lists the rules that govern multi-instance flows and their instances: what you can override for each resource type, how the base flow and instances interact, and what actions are blocked. Use it when you plan a multi-instance flow or when an instance doesn't behave as expected. Multi-instance flows are available in Professional and Enterprise editions.

What instances can override

Instances can override most configuration on the base flow, but the type of override depends on the resource. The following table lists each resource type and what an instance can change.

Resource Instance can Instance can't
Flow Change the name, description, settings, timezone, and the flows or exports that run next. Change the base flow it inherits from, or override the AI-generated description (aiDescription).
Connection Replace a base flow connection with a different connection. Edit the base flow connection's settings.
Export or lookup Override individual export or lookup fields, or replace the whole export or lookup with a different one. No restrictions documented.
Import Override most fields, including mappings and hooks. Replace the import with a different one.
Router and branch Override router fields and branch fields, such as a branch's input filter. No restrictions documented.
Hook Change which script and function the hook calls (_scriptId, function). Edit the script's code.
Webhook listener Replace the listener export with a different listener export, using JSON. Override the listener's URL or shared secret on its own.

Some fields can't be overridden, and integrator.io doesn't publish a complete list of them. An override for a field that can't be overridden is ignored without an error. To confirm an override took effect, see Override instance configurations with JSON.

Base flow rules

The base flow holds the shared configuration and controls several behaviors of its instances.

  • A base flow must belong to an integration. It can't be a standalone flow.
  • You can't run a base flow manually or on a schedule. Only instances run.
  • You can't define overrides on a base flow or on a standard flow. Overrides exist only on instances.
  • A multi-instance flow can't be the target of another flow's Run next setting. An instance can trigger other flows through its own run-next override.

Instance rules

Each instance is a separate flow with its own state, but it depends on its base flow.

  • An instance can't be a multi-instance flow.
  • Overrides are optional. A property without an override uses the base flow's value.
  • In the Simple view, an instance can change only the base flow's customizable properties. The JSON view can override additional fields.

On and off states

The base flow's on/off state takes priority over each instance's own state.

Base flow Instance setting Result
On On The instance runs on its schedule and can be run manually.
On Off The instance doesn't run.
Off On or off The instance doesn't run, and you can't change any instance.

When you turn a base flow back on, every instance that was on before you turned off the base flow turns back on. Turning off a flow stops future scheduled runs but doesn't stop a run that's already in progress.

Conversion and deletion rules

Converting and deleting are restricted while instances exist.

  • Converting a standard flow to a multi-instance flow hides its run history, because a multi-instance flow has no Run history tab. The run history isn't deleted and is shown again if you convert the flow back.
  • You can't convert a multi-instance flow back to a standard flow while it has instances. Delete all instances first.
  • You can't delete a multi-instance flow while it has instances. Delete all instances first.
  • You can't delete an instance or a base flow while it's turned on. Turn it off first.

Webhook rules

All instances share the webhook listener on the base flow.

  • Instances can't override an individual listener property, such as the URL or shared secret.
  • Instances can add their own transformations and filters to process the incoming payload, through a JSON override on the listener export. A listener step doesn't appear in the Customizable properties panel.
  • An instance can replace the listener export with its own listener export through a JSON override. Use this when each instance needs a unique URL or secret.