Integrations
Go to Integrations > General to review provider availability, connection health, and the next action PeakPOS currently supports for your organization.
Access and scope
The page is organization-scoped. It appears only when you have both:
org.readorg.integrations.read
Linked actions can have narrower gates:
- QuickBooks opens for users who can access General, but connecting, reconnecting, disconnecting, changing mappings or modules, syncing, and retrying failures require both
org.writeandorg.admin. Other users see the QuickBooks page read-only. - Scan Data diagnostics require a selected store and
store.mkonnekt.read; without that permission, the card shows Diagnostics unavailable. - Uber Eats View orders requires a selected store, the
peakpos.salesfeature, andstore.transactions.read.
If General is missing, ask an organization administrator to verify both organization permissions. If the page opens but a linked action is unavailable, read the explanation on that provider card before requesting broader access.
Understand provider status
Each card separates availability from connection health.
Availability
- Live: PeakPOS has a merchant-facing provider workflow.
- Support managed: Peak Support configures the integration; the portal may provide diagnostics.
- Coming soon: The provider is listed for evaluation, but setup is not available yet.
- Not self-service: The related workflow may exist, but this portal cannot configure the provider.
Connection health
Live merchant-managed integrations can show:
- Connected: the provider connection is active.
- Not connected: no active connection is available.
- Pending: connection setup has not completed.
- Needs attention: the provider connection failed or reported an error.
- Disabled: the saved integration is inactive.
- Sync needs attention: the connection is still connected, but one or more sync operations need review.
The card also shows Last sync when a live provider has a recorded sync time. Other cards show Readiness instead.
Providers shown on General
The current page contains only these providers:
| Provider | Current portal behavior | Supported next action |
|---|---|---|
| QuickBooks | Live; connection and sync health are shown | Manage QuickBooks opens the connection and sync page; changes require both org.write and org.admin |
| Scan Data | Support managed | View diagnostics opens selected-store diagnostics when you have store.mkonnekt.read |
| Uber Eats | Not self-service for setup | View orders opens Delivery Orders when a store is selected and both the peakpos.sales feature and store.transactions.read are available |
| Xero | Coming soon | Setup request is not yet enabled; contact Support if you want to evaluate it |
| FreshBooks | Coming soon | Setup request is not yet enabled; contact Support if you want to evaluate it |
| DoorDash | Coming soon | Setup request is not yet enabled; contact Support if you want to evaluate it |
| HubSpot | Coming soon | Setup request is not yet enabled; contact Support if you want to evaluate it |
| Gusto | Not self-service | Contact Support; payroll setup is not self-service in the portal |
Do not use accounting instructions for delivery, payroll, CRM, or Scan Data providers. Their supported next actions differ.
Check an integration
- Confirm the organization in the sidebar.
- Go to Integrations > General.
- Find the provider under Accounting, Payroll, Delivery, Loyalty & CRM, or Scan Data.
- Read both badges: availability first, then connection health if present.
- Review Last sync or Readiness.
- Follow only the enabled action on the card.
The count at the top reports merchant-managed integrations currently eligible for sync. Support-managed and non-self-service providers are not included in that count.
Respond to QuickBooks health
- If QuickBooks is Connected and has no attention badge, use Manage QuickBooks to review its supported sync areas.
- If it is Not connected, Pending, Disabled, or Needs attention, select Manage QuickBooks and review the connection state shown there.
- If it says Sync needs attention, review the safe status details on the QuickBooks page. Users with both
org.writeandorg.admincan retry failed work there. - Connecting, reconnecting, disconnecting, changing sync settings, and retrying require both
org.writeandorg.admin. If you have read-only access, ask an organization administrator with both permissions to perform the supported action. - If the supported reconnect or retry does not recover the integration, contact Support. PeakPOS withholds provider error details that could expose credentials.
Do not send your QuickBooks password, authorization code, access token, or other credentials to Support.
Use Scan Data diagnostics
Scan Data tobacco discount lookup and weekly reporting are configured with Peak Support.
- Select the store whose Scan Data behavior you want to inspect.
- Go to Integrations > General.
- On Scan Data, select View diagnostics.
- If the action says Diagnostics unavailable, ask an administrator to verify
store.mkonnekt.readfor the selected store. - Contact Support for setup or configuration changes.
Delivery providers
For Uber Eats, use View orders to open Delivery Orders when you have a selected store, the peakpos.sales feature, and store.transactions.read. Order status changes remain read-only until platform sync is enabled, and provider setup is not self-service here.
DoorDash is currently Coming soon on the integration page. Do not expect a connection workflow or live order sync from its disabled request action.
What to send Support
If a supported connection remains unhealthy, email [email protected] with:
- Organization and affected store, if store-specific
- Provider name
- Availability and connection badges shown
- Last sync time, if shown
- The action you tried and the exact on-screen message
- Approximate time the problem occurred
Never include passwords, one-time codes, API keys, tokens, private certificates, or screenshots that expose those values.