Docs Getting Started

Overview and Key Concepts

Welcome to Deepwell! This guide walks you through Deepwell from setting up your account to delivering Reports to your clients.

What Deepwell is

Deepwell helps you bring together the data stored in the various tools used by an MSP (managed service provider) so you can deliver reporting that illustrates the value you provide to your clients.

Deepwell can get data from many kinds of tools you already use, for example: PSAs, backup systems, security systems, and more. AI assistance helps you set up your Connections and Data Sources, so you spend less time on configuration. Every number in a Report comes from your own connected systems, and AI never invents data. Review each AI Generated Summary before you deliver it.

That means less manual work for you, and your clients finally get a clear view of what they're paying for, delivered under your own brand and your own domain.

How the parts work together

Everything in Deepwell follows one path, from the tool you connect to the Report your client receives.

Pipeline: a Connection leads to Organizations, which leads to a Data Source, which leads to a Visualization, which leads to a Report, which leads to a Report Snapshot.
The Deepwell pipeline. Set it up one time, then use it for each Report.

You set up the first part of the path only once: connect your tools, add your Organizations, and specify your Data Sources. After that, the same setup serves many Reports.

Each Report serves many clients too, because you select the Organization when you run it, so one Report about backup health covers every client you have. Build one Report for each subject you report on, not one for each client.

Key concepts

Here are the terms you'll see in the app and throughout this guide.

Term Definition
Organization A client that you manage. Deepwell identifies each Report and each Report Snapshot with an Organization.
User A person with an account. An MSP User is a person on your team. An Organization User is a contact at a client who reads the Reports that you deliver.
Integration An external product that Deepwell can connect to, for example ConnectWise PSA, Acronis, or SentinelOne. A Custom Integration connects to a REST API with no named Integration.
Connection Your credentials for one Integration, kept on the Connections screen. Deepwell makes a Connection when you connect an Integration.
Mapped Organization A client with a link to its related record in another connected system. For example, a link from the record of a client in ConnectWise to the record of the same client in SentinelOne.
Data Source A configured source of data that a Report reads. Deepwell gets this data through one of your Connections each time that a Report runs.
Report Block One unit of Report content on a page, of two kinds. A Visualization Block is a chart, and a Text Block holds the written parts of a Report: a Title, a Sub Title, Text, an AI Summary, a Divider Bar, and merge fields that Deepwell fills in with the name of the client, the name of your MSP, or the date of the run.
Report A document of pages and blocks. You build a Report one time, then run it for each client.
Report Snapshot The result of one run of a Report, holding the data and the pages of that moment. Your client sees it after you deliver it.
Schedule A Recurring run or a single run that you set on a Report, after which Deepwell makes and delivers the Report Snapshots automatically.

How Deepwell bills. Deepwell bills per client, not per Report, and an active client counts once however many Reports you deliver to them. On your renewal date, a client is active if you delivered a Report Snapshot to them in the three billing months before it, or if they have an active Schedule. There's no limit on how many inactive clients you keep. For what makes a client active, see Run, Schedule, and Deliver Reports.

Roles and access

Role Who Permissions
MSP User A member of your team Build Visualizations and Reports, set up a Schedule, and read Report Snapshots.
MSP Admin A member of your team with more permissions All the permissions of an MSP User. Also: control Connections, run the PSA synchronization, invite the contacts of a client, map Organizations and approve a mapping, remove the mapping of an Organization, control the team, set up the custom domain and the brand color, make and edit Data Sources, run a Report immediately, pause, resume, or delete a Schedule, archive or restore a Report, deliver a Report Snapshot, see the Review queue and the Dashboard summary, and set the AI language rules.
Organization User A contact at your client Sign in to your portal and read the Report Snapshots that you deliver to their Organization. Read only.

How your clients receive Reports

Your clients read their Reports in your white label portal. Once you deliver a Report Snapshot, the contacts at that Organization can sign in and read it.

Where to go next

Last updated