Connections
Settings → Connections is the one place you connect the systems your terminal reads. There are no files to edit and nothing to restart. This page explains how every card works. Each connector also has its own page; the card's Help link opens it.
The cards #
Cards are grouped as Money, Customers, Marketing, People, Communications, IP & Legal, Infrastructure, Intelligence and Governance. The header shows how many available connectors are connected and passing their test.
Each card shows:
- a badge: Ready (you can connect it), Beta, or Planned (listed so you can see what's coming; it can't be connected yet and shows "Coming soon");
- Feeds: the screens it fills;
- one row per place it can be connected.
Rows depend on the connector:
| Connector type | Rows |
|---|---|
| Company-wide | One row, Global. |
| Per brand | One row per brand. Long lists collapse to the connected brands; use "Show all … brands" to see the rest. |
| Either | A Global row, plus a row for each brand you add with Add for a brand. |
Status chips #
| Chip | Meaning |
|---|---|
| Not connected | Nothing saved for this row. |
| Untested | Saved, but not tested yet. Open it and press Test. |
| Connected ✓ | Saved and the last test or sync passed. |
| Error | The last test or sync failed. The line under the row says why. |
| Needs re-auth | The provider no longer accepts the sign-in. Open it and connect again. |
| Disabled | Paused by an admin. No syncs until it is enabled again. |
Connecting a row #
- Press Connect on the row. The panel opens with Setup steps on the left and the form on the right. Open provider docs ↗ links to the provider's own guide.
- Fill in the fields. Required fields are marked with
*. - Press Test. It runs one read-only call with what you typed and shows the result. Nothing is saved yet.
- Press Save. You'll see "Connection created", then press Test again so the saved settings are checked.
Connectors that use a provider sign-in (QuickBooks, Xero, Gusto) have no form. Press the green Connect to … button, sign in with the provider, approve read access, and you land back on this screen. The terminal keeps its own sign-in in memory only, so you may need to sign in again when you return.
Editing, pausing and retiring #
- Edit reopens the panel. Secret fields are never shown again: leave one blank to keep what is stored, or type a new value to replace it. Then Save changes. If you edit and press Test before saving, the button reads Test saved settings, because it tests what is stored.
- Disable pauses all syncs. Enable turns them back on.
- Retire stops every sync for good (press it, then confirm). Its history is kept. QuickBooks uses Disconnect from QuickBooks instead; see QuickBooks.
- History at the bottom of the panel lists the last changes, tests and syncs with who did them.
Who can change connections #
You need the connections admin role (or founder). Without it the panel says "You can see this connection but not change it" and the buttons are greyed out.
Common messages #
These can appear on any connector:
| Message | What to do |
|---|---|
| "(field name) is required." | Fill in that field. |
| "That doesn't look like a valid …" | The value doesn't match the expected shape. The message shows an example. |
| "Use a full https:// address" | Addresses must start with https://. |
| "Fix the highlighted fields, then Test again." | Correct the fields marked in red. |
| "Nothing changed" | You pressed Save changes without editing a field or typing a new secret. |
| "… points at a private or reserved network address, which this terminal won't call." | The terminal only calls public internet addresses. Use the service's public address. |
| "… doesn't resolve. Check the address." | The host name has a typo or doesn't exist. |
| "… didn't answer within 15 seconds." | The service is slow or down. Try again later. |
| "The server redirected. Enter the final address as the base URL." | The terminal never follows redirects. Use the address the service redirects to. |
Built-in connectors without their own page #
Brand system. Per brand. Reads a brand's own backend for customers, subscriptions, uptime and open tickets. Feeds the brand page live card and the portfolio overview. Your brand's backend must publish GET /vxt/summary (the VX Terminal summary contract) behind a read token. Enter the Base URL (without /vxt/summary) and the Read token. Test fetches the summary once.
Marketing platform. Company-wide. Reads site score, campaigns, claims and registrations for every brand from a marketing platform that publishes /vxt/summary. Enter its Base URL and Read token.
Server estate API. Company-wide. Reads health, load, disk, pending updates and reboots for every server from an estate API. Enter its Base URL and Read token. Test fetches /estate/summary once and reports how many servers answered.
For all three, Test reports "The server refused the token." when the token is wrong, and "Nothing answers at … on that host. Check the base URL." when the address is wrong.
Planned connectors #
Payroll / HRIS (Rippling or ADP) and VX CTRL (running the terminal bound to VX CTRL) are listed as Planned. Gusto already has its own card.