ConnectWise Manage Setup Guide
Purpose
This document outlines the standardized steps for setting up an API integration between ConnectWise Manage and Mizo, including API key creation and Pod configuration.
Section 1 – Setting up the base configurations in Mizo
Step 1: Configure Integration in Mizo
- Log into the Mizo console.
- In the left-hand menu, go to Integrations.
- Select ConnectWise Manage from the list.
Step 2: Enter ConnectWise configurations
- Instance URL:
- Your ConnectWise instance URL (e.g.,
https://{{your-company-name}}.connectwise.com
).
- Your ConnectWise instance URL (e.g.,
- Company ID:
- Your ConnectWise Company ID used during authentication.
- Public Key:
- Will be covered in section 2.
- Private Key:
- Will be covered in section 2.
- Instance URL:
Section 2 – Creating an API Key in ConnectWise Manage
Step 1: Log in to ConnectWise Manage
- Sign in to your ConnectWise Manage instance using an Administrator account.
Step 2: Create a Security Role for the Integration
- Navigate to System > Security Roles.
- Click + to add a new role.
- Configure the role:
- Role ID:
Mizo Agent Role
- Click Save.
- Role ID:
- Apply the following permissions:
Permissions Matrix
Module | Feature | Permissions |
---|---|---|
Company | Company Maintenance | Add, Edit, Inquire → All |
Contacts | Add, Edit, Inquire → All | |
Notes | Add, Edit, Inquire → All | |
Manage Attachments | Inquire → All | |
Service Desk | Service Tickets | Add, Edit, Inquire → All |
SLA Dashboards | Inquire → All | |
System | Table setup | Inquire → All |
Step 3: Create an API Member
- Go to System > Members.
- Open the API Members tab.
- Click + to create a new API member.
- Fill in the following details:
- Member ID:
mizo_ai_agent
- Role ID:
Mizo Agent Role
- Level: Typically
Corporate
- Access to boards can be managed in Mizo. You don’t have to restrict access to board in ConnectWise
- Member ID:
- Click Save.
Step 4: Generate the API Keys
- Once the API Member is saved, go to the API Keys tab.
- Click + to generate a new API key.
- Configure:
- Key Name: e.g.,
MyIntegrationKey
- Key Name: e.g.,
- After saving, note the generated keys:
- Public Key, add it to the mizo console.
- Private Key ⚠️ Important: The Private Key is displayed only once — copy it immediately and add it to the Mizo console.
Step 5: Save configuration in Mizo
- Save the configuration in the Mizo console.
- Ensure that the connection test is successful. If not, validate the login information or API keys.
- Copy the Pod URL for the next section.
Section 3 – Creating the Mizo Pod in ConnectWise Manage
Step 1: Log in to ConnectWise Manage
- Use an Administrator account to sign in.
Step 2: Navigate to Hosted API Settings
- Go to System > Setup Tables.
- Search and select Manage Hosted API.
Step 3: Add a New Hosted API (Pod)
- Click + to add a new entry.
- Fill in the following fields:
- Description:
Mizo Agent Pod
- Screen:
Service Ticket
- URL: The full Pod URL provided by Mizo after registration.
- Origin: The pod URL from section 2 (e.g.,
https://app.mizo.tech/hostedapis/connectwiseiframe/{{your-company-id}}
). - Pod Height: Recommended value:
600
- Description:
- Click Save.
Section 4 – Test setup
Step 1: Navigate to one ticket
- Open a ticket in your ConnectWise Manage service desk
- The Mizo pod should appear.
- While Mizo is catching up on your ticket, you might receive an error that this ticket is not processed by Mizo. This is normal.