Where to find it
In the admin sidebar, under Droplets, select Marketplace, then click your connector’s card. The connector’s screen appears once its droplet is installed. Until then, the card opens the droplet’s marketplace listing, where Install adds it. See Droplets.To open this screen, your role needs View only or Full access for Droplets. Installing the connector’s droplet needs Full access. On the Roles screen, Droplets is in the Tools & Messaging card.
Connect your back office
A connector that isn’t connected yet opens on Credentials. The fields depend on the connector:- Name for your integration: at least 3 characters.
- Company: if your connector asks for it.
- Type: Production, the default, or Sandbox. Some connectors, such as Exigo, also ask for a Sandbox ID when you choose Sandbox.
- API Credentials: depending on the connector, an API URL (if the connector asks for it), plus either a Username and Password or an API Token. The eye button shows or hides what you typed.
- Database Credentials: if the connector also reads your back-office database, its Data Server, Database, Username and Password. The section lists the addresses to allow on your database server.
1
Open the connector
Open the connector’s screen as described in Where to find it.
2
Fill in the connection details
Enter a name for the connection and the details your connector asks for. Fields marked with an asterisk are required.
3
Test the connection
Click Test Connection. Testing Connection… shows while Fluid checks your credentials. If they work, you see Integration connected successfully!. If not, you see Error testing connection: followed by the reason. Correct your details and try again.
4
Wait for the connection to start
The screen reads Please wait while the integration is being initialized… and checks again every few seconds. When it’s ready, Integration Connected! appears.
5
Continue
If your connector has setup steps, What’s next? names them. Click Continue to Setup. Otherwise, click View Integration to open the dashboard.
Finish setup
Setup has up to two steps after Connect, depending on the connector: Import Preferences and Data Mapping. Click Import Preferences or Data Mapping at the top to move between setup steps.1
Choose what to import
On Import Preferences, switch on the record types to sync, such as Orders, Products and Customers. Only the types your connector supports appear. Each card lists what it includes. Under Sync Direction, choose Import, Bidirectional or Export. Only the directions your connector supports appear.
2
Check your mappings
Click Save & Continue. On Data Mapping, use Sections to jump between mapping sections and check how your back office’s values match Fluid’s. Export saves your mappings as a JSON file. Import loads a saved file and, once you confirm with Replace All, deletes every existing mapping and replaces it with the file’s. This can’t be undone.
3
Complete setup
Click Complete Setup. Fluid saves your choices and opens the connector’s dashboard.
The dashboard
The header shows the connector’s name and the direction data flows (point at it for details). If a banner says Setup hasn’t finished — this integration isn’t syncing yet., click Retry setup. If the banner doesn’t clear, check your credentials. The tabs, in screen order, if your connector uses them:- Overview: sync health for the range you pick, the Needs attention card and the activity log. See Check sync health.
- Reconciliation: compares Fluid with your back office by external ID. Each record type shows In Fluid, the count in your back office and the Difference. Check now refreshes the counts; it doesn’t sync or repair records. When a record type has differences, View records lists the affected records, and you can download them as a CSV file.
- Import preferences: what syncs and in which direction. See Change what syncs.
- Data Mapping: how your back office’s values match Fluid’s, grouped by record type, such as Customers, Products and Orders, with a Search mappings… box. A group can also have a settings card for that record type.
- Rules: the rules your connector offers, such as what happens to Duplicate records (customers and orders), Refund orders and Products without a warehouse. Each rule marks its recommended option, and your pick saves as soon as you make it.
- Settings: Edit credentials, plus any settings your connector supports, such as Bundle export for Exigo, which sets how product bundles are written to Exigo orders.
- Reports: CSV exports of your sync activity.
Check sync health
On Overview:- Pick 24h, 7d or 30d. The counts, the chart and the activity log follow the range. The log shows 10 rows a page; use Next and Previous to move through the most recent events.
- Cards show how many of each record type synced. Click one to filter the activity log to it.
- Needs attention has a tile for each kind of problem: Held (waiting on a mapping), Failed, Skipped (filtered by a rule) and Quarantined (held for review after repeated failures). When there’s nothing to fix, it reads All clear.
- The activity log opens on Needs attention; All adds successful syncs. Trends groups errors that repeat, and Inbox groups failed, held and skipped syncs by category. In both, expand a group and click view all to list its records.
- To find a record, type at least two characters in Search… and press Enter. The search covers all time. Press Esc to clear it.
- Click a row to see its details: its Fluid and external IDs, its retries, and the error, missing mapping or rule behind it. In the row’s three-dot menu, Open record in Fluid opens the record in the admin in a new tab. If the record has no admin link yet, you see Not linkable yet.
Fix a held record
A record is held when one of its values has no mapping. Fixing it needs the Data Mapping tab, so it’s available only if your connector shows it.1
Open Fix mappings
On Overview, in Needs attention, click Fix mappings on the Held tile. The Fix mappings panel lists each unmapped value, how many events it’s holding, and a suggestion when there is one.
2
Open the mapping
Click Open mapping. The Data Mapping tab opens at that mapping.
3
Choose the match
Set the value’s match in that section. In most sections, you choose it from the value’s row menu or click the value after Suggested:. The change saves right away.
4
Replay the held records
In the activity log, click the filter button and check Held. Check the rows and click Replay. You see Replay started.
Retry a failed record
1
Find the failed records
On Overview, in the activity log, click the filter button and check Errors. Click a row to see the error.
2
Replay them
Click the Replay sync button on the row, or check several rows and click Replay. You see Replay started.
Review quarantined records
Records go to quarantine after their retries run out.1
Open the quarantine queue
On Overview, in Needs attention, click Review on the Quarantined tile. The queue lists the first eight records; handle them and reopen it to see the rest.
2
Retry or exclude each record
Click Retry now to queue the record again. To stop a record from ever syncing, click Exclude, enter a Reason and click Confirm exclusion. Right after you confirm, the dialog changes and offers Unexclude to undo it. After you close the dialog, the record no longer appears in the queue.
Change what syncs
On Import preferences:- Sync direction: import from your back office, Bidirectional or export to it, as your connector supports.
- A switch for each record type your connector supports, such as Orders, Products and Customers.
- For Exigo, Points syncs Fluid Points with Exigo point accounts. Set up the accounts on Data Mapping.
Email Fluid support at help@fluid.app. The Getting help page lists what to include in your request.
Update credentials
1
Open Edit Credentials
On Settings, click Edit credentials. The dialog opens with your saved details; sensitive values can appear masked.
2
Change the details
Change what you need. Fields marked with an asterisk are required, including Sandbox ID if you use a sandbox. Name for your integration can’t be changed here.
3
Save
Click Update Credentials. You see Credentials updated. If the save fails, you see Failed to update credentials with the reason.
Download a sync report
1
Set the range
On Reports, under Generate sync activity report, pick a Start date and End date. They start at the last 7 days. Choose an Entity type, or leave All entity types.
2
Generate the report
Leave Hide system-skipped and waiting rows (recommended) checked unless you need those rows, then click Generate report.
3
Download it
Under Your reports, the report shows Preparing… while it builds. When it’s ready, click Download CSV. If a report fails, Failed appears instead; generate it again. Reports are kept for a limited time.
Frequently asked questions
Why don't I see a tab or setting described here?
Why don't I see a tab or setting described here?
Each connector’s configuration decides which tabs, cards and settings appear, and some settings exist for only one back office. A tab your connector doesn’t use isn’t shown.
The setup steps didn't come back. How do I finish setup?
The setup steps didn't come back. How do I finish setup?
Setup steps show once, right after you connect. If you leave before you complete them, the connector opens on the dashboard next time. Make the same choices on the Import preferences and Data Mapping tabs.