Skip to main content

Connector Details

Overview

The QuickBooks Web Connector (QBWC) is a Windows application from Intuit that ships with QuickBooks Desktop. It acts as a bridge between a QuickBooks company file and a web service: on a schedule you configure, QBWC contacts hotglue, picks up any pending read or write requests, runs them against the company file, and sends the results back. Compared to the installed QuickBooks Desktop connector:
  • Nothing to install from hotglue. Your tenant only needs a .qwc configuration file and a connector password. There is no .exe to download, run as administrator, or keep in a startup folder.
  • Works with hosted QuickBooks (e.g. Rightworks), where the Web Connector is already installed.
  • Supports V2 flows.
  • Tables are selected via field map, like a normal cloud connector.
Because QBWC polls hotglue on an interval rather than holding an open connection, reads and writes are asynchronous: a job queues its requests and completes once the Web Connector’s next sync processes them.

Enable and set up your connector in hotglue

Set up your flows

Enable the QuickBooks Web Connector in your read flow, and in your write flow if you need to write data back to QuickBooks Desktop. The data format for both reads and writes is the same as the installed QuickBooks Desktop connector. For detailed behavior and business logic (upserts, processing order, batching, and per-record errors), see the connector README.

What your tenant needs

Each tenant needs two things to connect the Web Connector:
The .qwc file and connector password must belong to the same tenant ID. A file paired with another tenant’s password will not work.

Set up your tenant

The simplest way to set up a tenant is to link the QuickBooks Web Connector through the hotglue widget, either embedded in your app or opened via a magic link. Linking from the widget handles everything for you:
  • Generates the tenant’s connector password
  • Links the tenant to your flows
  • Generates the tenant’s .qwc file
Once linked, the widget shows a download link for the .qwc file and a copy button for the connector password. The tenant can then follow the end-user instructions below. White-labeling: The .qwc file sets the application name your tenants see in QuickBooks and the Web Connector. To use your own branding for .qwc files downloaded from the widget, go to Settings > Connectors > Quickbooks Web Connector and change these values:

Option 2: Set up the tenant via API

If you’d rather set up tenants programmatically, you can generate the password, link the tenant, and generate the .qwc file yourself.
1

Generate the connector password

The Web Connector accepts the same connector password as the installed connector, and uses the same endpoint to generate it:
cURL
If you haven’t generated a signing key before, this request will error with: No signing key has been created for this environment. To resolve, go to Settings > API Keys, and click Generate Signing Key.
2

Link the source

Pass the connector password as token in the config of a POST to /linkedSources. Unlike the installed connector, you don’t pass company_file_path or tables; tables are selected via field map.
cURL
object
required
3

Link the target (write flows only)

If you’re writing data to QuickBooks Desktop via a separate V1 write flow, either symlink the target config to the source config, or pass the same token in a POST to /linkedTargets:
cURL
4

Generate the .qwc file

Generate the tenant’s .qwc file from the following public URL:
The .qwc file isn’t secret on its own, since it only works alongside the matching connector password. You must still generate a separate file for each tenant, because it embeds the tenant ID.
Once you have the connector password and .qwc file, send both to your tenant along with the end-user instructions below.

Optional: Connect additional company files

Each QuickBooks company file is connected as its own subtenant. For each additional company file:
  1. Create a subtenant in hotglue (for example, test-user_1).
  2. Get a connector password and .qwc file for the subtenant, either by linking the Web Connector in the widget for the subtenant, or by following the API steps above with the subtenant ID in place of <TENANT_ID>.
  3. Have the user open the other company file and repeat the end-user instructions with the subtenant’s .qwc file and password.

End-user instructions

Requirements

1. QuickBooks Desktop with the QuickBooks Web Connector Only Windows versions are supported. The Web Connector comes pre-installed with modern versions of QuickBooks Desktop, and is already installed on hosted QuickBooks environments such as Rightworks. 2. The .qwc configuration file 3. The connector password

Connect the Web Connector

If you previously used the hotglue QuickBooks Desktop Connector (.exe) on this machine, stop it and remove it from your startup folder before continuing.
1

Open your company file

Open QuickBooks Desktop and log in to the company file you want to connect.
2

Open the Web Connector

Go to File > App Management > Update Web Services.
3

Add the application

Click Add an Application and select the downloaded .qwc file. When QuickBooks asks you to authorize the new web service, click OK.
4

Grant access

QuickBooks will ask what access to give the application. Select Yes, always; allow access even if QuickBooks is not running, and choose a QuickBooks user that won’t cause access conflicts (for example, a user that isn’t also logged in to the company file by someone else). Then click Continue and Done.
If you’ve used the installed hotglue connector, this is the same access prompt you saw then.
5

Enter the password and enable syncing

You’ll return to the Web Connector’s list of applications, which now includes the hotglue application. For that application:
  1. Enter the connector password in the Password field (click Yes if asked to save it).
  2. Check Auto-Run, and set Every Min to 5.
  3. Check the checkbox on the left of the application’s row, and click Update Selected.
Once the update completes successfully, the Web Connector will sync with hotglue every 5 minutes and you’re ready to start running jobs.

Migrating from the installed connector

To move an existing tenant from the installed QuickBooks Desktop connector:
  1. Enable the QuickBooks Web Connector in your read and write flows. Your existing export script continues to work as-is.
  2. Get the tenant’s connector password and .qwc file, either by linking the Web Connector in the widget or via the API (see Set up your tenant).
  3. Select tables via field map.
  4. Have the tenant stop the installed connector, remove it from their startup folder, and follow the end-user instructions.