Dashboard guide
The dashboard at /dashboard is where you manage everything that is not code: keys, end users, setup links, webhooks, and the request log you use to investigate problems. It is one column, one job per page. The top bar holds the project switcher, the billing status and your account menu, with the project’s pages below: Home, End users, Requests, API keys and Webhooks. Projects, Team, Billing and Settings are in the account menu.
Getting started
Section titled “Getting started”Sign up at /dashboard/sign-up with your name, work email and a password of at least 12 characters, then confirm your email address. Your first visit creates your organization, named after your email domain, and a free test project named Development. The Name your organization prompt on the project home page lets you keep or change that name.
The project Home page shows a Get started checklist: create a secret key, create an end user, connect QuickBooks Desktop, make your first request. Once every step is done it shows an overview instead. Connections needing attention and Recent errors (failed and uncertain requests in the last 7 days) are always below.
Projects
Section titled “Projects”Projects lists the projects in each of your organizations, and Create a project adds one. Choose the environment when you create a project, Test or Production; it cannot change later. Owners and admins can rename a project, or delete it by typing its name to confirm. Deleting a project stops its keys, setup links and Web Connector connections immediately, and the project leaves your list. Owners can also Move to another organization where they are an owner or admin; keys, end users, connections, the request log and webhook endpoints move with the project and keep working.
API keys
Section titled “API keys”API keys creates and revokes secret keys and shows the publishable key.
- Create secret key asks for a key name and access: Full access (reads and writes) or Read-only (GET operations and query-only passthrough, for AI agents and MCP clients that should not change data). The full key is shown once. Copy it and click I copied the key.
- The list shows each key’s prefix and last four characters, its access, creation time and Last used time. Revoke stops a key within 30 seconds.
- The Publishable key has a copy button and Rotate. Setup links you already created keep working until they expire.
Owners and admins manage keys. See Authentication and API keys.
End users
Section titled “End users”End users lists your end users with their connection status. Search by company, source ID, email or ID, filter by status and sort the list. Create end user asks for company name, source ID and email, then opens the end user’s page to create a setup link.
An end user’s page shows:
- Setup link: choose Expires after (30 minutes, 1 day or 7 days) and an optional redirect URL, click Create setup link, and copy the link. It is shown once. Earlier links are listed with their status.
- Connection: status, the QuickBooks company, product and qbXML version, last Web Connector check-in, last request, last successful request and when setup completed. When a connection has a problem, it shows why and How to fix it.
- Test connection: runs a health check and shows Connection OK with the round-trip time, or the error.
- Reset company file path: use it after your customer moved or renamed the company file. See Connection status.
- Disable and Enable: owners and admins can pause a connection; its requests fail until you enable it again.
- Web Connector installs: each connector that served this connection, so you can see when a customer moved computers.
- Company file mismatches: when QuickBooks had a different company file open in the last 30 days.
- Recent requests with a link to all requests for this end user.
- Details: edit company name, source ID and email.
- Move to another project: move the end user, with its connection and request log, to another project of the same environment.
- Delete end user: type the company name to confirm. This deletes the end user, its connection and its stored request data.
Request log
Section titled “Request log”Request log lists every QuickBooks-bound request in the project, newest first, for the last 30 days. Filter by status, end user, operation and time.
A request’s page shows:
- its status, end user, call, outcome, timings (time in queue, time in QuickBooks, total) and whether an idempotency key was sent;
- the Error, with cause, fixes and a link to the error reference;
- QuickBooks: the native status code and severity, the native message, the qbXML version, and any Warnings;
- the Timeline of status changes, each with a UTC timestamp;
- the Response body, with personal and payment fields redacted, while it is retained and when payload capture is on;
- Copy as cURL to reproduce a GET call.
When a customer reports a problem, ask for the time or look up the requestId from your logs and open it here. Request metadata is kept for 30 days and bodies for 15 days. See Request lifecycle.
Webhooks
Section titled “Webhooks”Webhooks lists the project’s endpoints with their status (Enabled, Failing or Disabled), the recent deliveries, and the event types. Add endpoint asks for an HTTPS URL, an optional description and the events to send, then shows the signing secret once.
An endpoint’s page shows its status, events and signing secret state, and the newest 50 deliveries with every attempt. From there you can Send test event, Rotate secret (for 24 hours each delivery is signed with both the new and the old secret), Resend a delivery, Edit URL and events, Disable endpoint or Enable endpoint, and Delete endpoint by typing delete. Owners and admins manage endpoints; members can view them. You can also manage endpoints through the webhook endpoint API.
Team lists members and pending invitations. Owners and admins invite people by email and pick a role, Member or Admin:
| Role | Can |
|---|---|
| Owner | Everything, including billing, changing member roles, removing owners and moving projects to another organization |
| Admin | Manage projects, keys, webhook endpoints, settings and branding, invite and remove members, disable connections, and move and delete end users |
| Member | Use end users, setup links, test connection, reset company file path and the request log |
Only owners change roles, with Make admin or Make member. Invitations can be resent or revoked.
Billing
Section titled “Billing”Billing is visible to owners; members see the billing status in the top bar and billing banners only. It shows the plan status and dates (trial end and days left, billing period, grace period end, access end), Add billing or Manage billing, the production company files for the period with end user, project, active days and a Billable, Trial or Not billed badge, and an estimated charge. If you open a checkout link that belongs to another organization, or one that cannot be found, the page says so and nothing changes for the current organization. See Billing and pricing.
Settings
Section titled “Settings”- Organization name.
- Branding: a Display name and a logo (PNG, JPEG or WebP, up to 256 KB) that end users see in the hosted setup flow. Leave the display name empty to use the organization name.
- App name for the current project: the name your customers see in the setup flow and in the QuickBooks Web Connector. Existing Web Connector installs keep the name they were created with.
- Payload capture: keep request and response bodies for 15 days so they appear in the request log. Turn it off if you prefer not to store accounting data with us; with capture off, bodies are kept only while a request is in progress. Request metadata and timelines are kept for 30 days either way.
- Account: your name and Change password, which signs out your other sessions.
Owners and admins change organization, branding and project settings.