Integration settings
Every card and label on an Integration's tile and in the Integrations list, what it controls and when to change it.
Everything about how an Integration behaves is controlled from its tile. Open it from Settings → Integration setup → Integrations and click the arrow on an Integration to expand it.
For the settings inside each Configuration, see the settings page for your connector, such as Xero settings or Shopify order settings.
The cards on the tile
| Card | What it controls | Guidance |
|---|---|---|
| Activation | Whether the Integration is able to run. When disabled, no data is sent or received on it, even by hand. | Leave disabled until Configurations and Mappings are ready. To pause an Integration, disable it rather than removing it. |
| State | Whether the Integration transmits data as Live or Test. | Usually only has an effect on EDI Integrations. Leave unset if not required. |
| Configurations | What this Integration sends and receives: one Configuration per document type. | See Add a Configuration. |
| Schedule | The schedule on which the Integration runs. | Disabling the schedule means you must run the Integration manually to send and receive. See Set an integration schedule. |
| Default Unit of Measure | Forces all quantities received or sent on this Integration into one unit of measure. | Leave unset if the Integration should use each Product's default units of measure. |
| Manual Operation | Runs the Integration now: Run send & receive, Run send or Run receive. | Useful while testing or with no schedule. See Run an integration manually. |
| Credentials | View, add, edit and remove the credentials the Integration uses. | Correct a wrong password or a rotated key without removing and reconnecting. See Update integration credentials. |
| Webhooks | On Integrations that support them, such as Shopify and WooCommerce, a Setup button switches on webhooks so changes arrive instantly. | Recommended where available. |
| Remove | Permanently removes the Integration and any secure credentials. | Documents already associated with it are not removed. To use the system again you'd connect and configure it from scratch. |
Name, Key and Id
| Item | What it is |
|---|---|
| Name | Click the pencil next to the name to rename the Integration. You don't need to remove and reconnect it. Use names your team will recognise, especially for several Integrations of the same type. |
| Key and Id | Set automatically and used by the system. Quote the Id when you contact Support; it's the quickest way for them to find the Integration. |
What the Integrations list shows
Even with tiles collapsed, the list tells you:
| Indicator | Meaning |
|---|---|
| Enabled badge | The Integration is switched on. |
| Schedule | Whether it runs on a schedule, and when it next runs. |
| Webhooks | Whether it has webhooks set up. |
| Grey Uninstalled label | The Integration was uninstalled on the other system's side (for example, the Supply Lens app removed from a Shopify store). Its panel is greyed out and its settings can't be changed. You can still remove it and its saved credentials. |
Remove is permanent
Remove deletes the Integration and its credentials for good. Your Documents stay, but you'd have to reconnect and reconfigure everything. Set Activation to disabled to pause instead.