Channel Program integrates seamlessly with ConnectWise PSA to sync customer company data.
Follow the steps below to complete the integration.
- Available data sync options
- Configuring a new ConnectWise PSA user
- Generate an API Key
- Retrieving the ConnectWise public and private keys
- Retrieving the ConnectWise client ID
- Installing integration in Channel Program
Review available data sync options
The integration supports a one-way data sync from ConnectWise PSA to Channel Program. The specific data that will sync depends on the selected sync options. Before proceeding, review the available data sync settings to ensure they meet your requirements.
RECOMMENDATION: To ensure all relevant customer profile details are synced, enable both Active Customers and Active Customer Agreements.
Sync Type |
Sync Active Customers |
Sync Conditions |
|
Data Synced |
|
Triggering a Sync |
Data will sync under the following conditions
|
Sync Type |
Sync Active Customer Agreements |
Sync Conditions |
|
Data Synced |
Customer record
Agreement record
|
Triggering a Sync |
Data will sync under the following conditions
|
Configuring a new ConnectWise PSA user
While you can use an existing ConnectWise PSA user for the integration, it's recommended to create a dedicated user for Channel Program to ensure seamless operation.
- Login as an administrator into your ConnectWise PSA dashboard.
- From the side navigation mouse over System, then click Members.
- Click the API Members
- Click New Item.
- Enter in the profile details as follows:
- Member ID: Enter CPIntegration as the Member ID
- Member Name: Enter the name of Channel Program Integration
- Email: Enter an email address for the user
- Enter the system details as follows:
- Role ID: Select Admin
- Location: Select a location
- Business Unit: Select a business unit (e.g. Integration)
- All other options should be set to best reflect that this API member has a view of your entire organization not just a single location or business unit.
- Click Save.
Generate an API key
- From the new members profile, click the API Keys tab.
- Click New Item.
- Enter the description of CW Channel Program.
- Click Save.
- Copy and save the public and private API keys that were generated and store them for securely for later use. NOTE: The private key will never be displayed again if you leave the tab before copying the key.
Retrieving the ConnectWise client ID
You have two options available for retrieving the ConnectWise client ID. You can use an existing integration, or you can create a new integration.
Using an existing integration
- Navigate to ClientID - Developer Network (connectwise.com)
- If requested, log in.
- Click Copy for the Client ID that is presented and save it along with the public and private API keys.
Creating a new integration
- Navigate to ClientID - Developer Network (connectwise.com)
- If requested, log in.
- If a client ID is not presented. Click Create New Integration.
- Enter the integration name of Channel Program Integration
- Describe the integration – Channel Program one-way data sync from ConnectWise PSA.
- Select the Integration Type of Private.
- Enter a technical contact email.
- Select the product of Manage.
- Click Submit.
- Click Copy for the Client ID of the new integration created and save it along with the public and private API keys.
Installing integration in Channel Program
With the necessary details and configuration from ConnectWise PSA in place, you can now proceed to complete the integration installation in Channel Program.
- Sign into Channel Program as a company administrator.
- From the side navigation click Integrations.
- Find the ConnectWise PSA integration card and click View.
- Click Install for the preferred data sync, to start the installation process.
- On the installation screen, enter the following details:
- Username – Will be a combination of your company name and private key, separate by a plus sign. For example: samplecompany_c+a1bcDEdGHijklmn2
- Password – Use the public key saved earlier.
- Domain – The ConnectWise portal URL. For example: https://na.myconnectwise.net
- API Version – The ConnectWise API version. Example. If the version is v2020.3, you’d enter v2020_3.
- Client ID – Use the client ID saved earlier.
- Click Next.
NOTE: If you chose to install the Active Customer Agreements sync, it’s recommended to also enable Active Customers. This ensures that the customer profile is synced with all relevant information. To install Active Customers, simply click Install.
Congratulations! The integration has been successfully installed, and data sync will begin shortly. To confirm that the data is syncing, go to Manage Clients under NaviStack.
For ongoing management of your integration, please refer to How to manage integrations.