Free Plan Onboarding - Connectwise
Login to ConnectWise as an Admin and select System -> Members -> API Members as shown below:
Click on + as shown below:
Fill out all required fields and click Save button: Be sure to set the permission to "Admin". If you have a role ID other than Admin, please see the bottom of this documentation for setting permissions for a custom role ID.
Click on API Keys and then click on the + sign to add a new key:
Give it a description and click Save:
The keys will disappear after you click save and close so copy both now to a document or directly into MSP Process before you save and close in ConnectWise.
After you have saved the Public and Private keys to a clipboard or anywhere else for retrieval, the next step will be to enter this information into the MSP Process admin app. On your Onboarding session, please make sure to have these available.
Once instructed by your onboarding specialist, please perform the following tasks:
Now login to MSP Process and click on Integrations and click Integrations -> PSA Integrations. Click + to Add PSA and select ConnectWise.
Select ConnectWise
Enter your PSA Connection Details:
ConnectWise Permission Details
Introduction
At MSP Process we believe in only setting the minimum permissions required to leverage our application for your business needs. Please find the outline below along with a more granular review of the permissions.
Adding a Security Role for MSP Process
- Login to your ConnectWise Manager account
- Navigate to System -> Security Roles
- Add a new role, name it MSP Process, and give it the permissions listed below:
Area | Permission | |
Companies |
Company Maintenance: Inquire (All) Company/Contact Group Maintenance: Inquire (All) Contacts: Add/Edit/Inquire (All) CRM/Sales Activities: Inquire (All) Manage Attachments: Add/Inquire (All) Notes: Add/Edit/Inquire (All) Team Members: Inquire (All) |
|
Finance* | Invoicing: Inquire (All) | |
Project | Project Tickets: Inquire (All) | |
Service Desk |
Close Service Tickets: Add/Edit/Inquire (All) Resource Scheduling: Add/Inquire (All) Service Ticket - Dependancies: Add/Edit/Inquire (All) Service Tickets: Add/Edit/Inquire (All) Service Tickets - Finance: Inquire (All) SLA Dashboard: Inquire (All) Ticket Templates: Inquire (All)
|
|
System |
Member Maintenance: Inquire (All) Table Setup: Inquire (All) |
* only required if using the Invoices tab within the MSP Process Client Portal
4. Within the System area, click the customize link beside the Table Setup permission (screeshot below):
5. Make sure that all of the entries are "allowed access" as shown below. You may then save and close the MSP Process Security Role.
API Endpoints Used by MSP Process
This is a list of all APIs we get information from or post using the API connections. Please adjust your permissions based on the details below. Please note that some of these API requests are part of other functions of our app and are not needed for End User and SMS utilization.
Type |
API (resource) |
Description |
---|---|---|
GET |
|
Check is connection is valid |
GET |
|
Get statuses (company filters) |
GET |
|
Get types (company filters) |
GET |
|
Get statuses (configuration filters) |
GET |
|
Get types (configuration filters) |
GET |
|
Get configurations |
GET |
|
Get all companies |
GET |
|
For contact creation |
GET |
|
For contact creation |
GET |
|
note types |
GET |
|
contact notes |
GET |
|
contact |
GET |
|
contacts count |
GET |
|
valiadate client portal credentials |
POST |
|
request reset password |
System
Type |
API (resource) |
Description |
---|---|---|
GET |
|
Get resources |
GET |
|
Get API resources |
GET |
|
Get departments |
GET |
|
Get audit trial |
GET |
|
Get system callbacks |
Finance
Type |
API (resource) |
Description |
---|---|---|
GET |
|
Get the list of invoices |
GET |
|
Get a specific invoice |
Service
Type |
API (resource) |
Description |
---|---|---|
GET |
|
Ticket notes |
PATCH |
|
Update ticket note |
GET |
|
Ticket timeline |
GET |
|
Tickets |
GET |
|
Time entries |
GET |
|
Priorities |
GET |
|
tickets |
GET |
|
boards |
GET |
|
types |
GET |
|
subtypes |
GET |
|
items |
GET |
|
statuses |
GET |
|
impacts |
GET |
|
severities |
GET |
|
locations |
GET |
|
sources |
GET |
|
agreements |
Ticket Notes
Type |
API (resource) |
Description |
---|---|---|
POST |
|
toggle note type |
Time Entries / Schedule entries
Type |
API (resource) |
Description |
---|---|---|
GET |
|
time entries |
GET |
|
time entry |
GET |
|
work types |
GET |
|
work roles |
GET |
|
schedule entries |
GET |
|
schedule entry |
GET |
|
statuses |