Articles in this section

Customize integration settings

The Settings tab lets you add your own settings to an integration — values that its flows, exports, imports, and connections can read at runtime — and build a form that lets other users change those values without editing JSON. Use it when a choice should apply across several flows at once, for example a custom Shopify – Salesforce integration in which every flow should sync only paid orders: define the setting once, expose it in a form, and have each flow read it. This article explains what the tab contains and how custom settings, custom forms, and form builder fit together; the articles it links to cover each of them in depth.

Prerequisites: You must have Manage all permissions to change an integration's settings. See Manage user roles & permissions to an account.

In an integration app, the Settings tab holds the app's own configuration options, for the app as a whole or for a single store; see the integration app's documentation.

Custom settings, custom forms, and form builder

  • Custom settings are extra attributes you define on a resource — an integration, flow, export, import, or connection — stored as JSON and readable from anywhere in the integration's logic, including scripts. See Custom settings and forms.
  • Custom forms are the user-facing side of custom settings: a form that reads and writes the settings' values, so a user picks an option in a familiar interface instead of editing JSON. A form can prompt for information, react to what the user selects, and capture the result when it's submitted. See Custom settings and forms.
  • Form builder is the editor you design custom forms in. Select Launch form builder on the Settings tab to open it. For the editor itself, see Advanced field editors (AFEs) and the Playground; for a working example with sample JSON, see Dev playground.

A typical configuration has three parts: define the custom settings on the resource you want to make configurable, build a custom form that exposes them, and then reference the settings from your flows, exports, imports, or scripts so the form's values change behavior at runtime. Once the form is saved, it appears on the Settings tab, and users change values there without touching JSON.

Custom settings and forms are also how a published template or integration app adapts to each customer's environment; see Publish or unpublish templates and integration apps.

Open the Settings tab

  1. Go to Home home-icon.png, and then open the integration.
  2. Select Settings.
  3. Edit the JSON in Settings, or select Launch form builder to design a form, and then select Save.

JSON settings aren't available for APIs.