ConnectWise Manage

Provides integration with ConnectWise Manage (ConnectWise PSA) using the REST API.

Revision History

0.0.0.1 - Initial release.
0.0.0.2 - Maintenance update.
0.0.0.3 - Fixed error message handling.
0.0.0.5 - Separated methods and templates.
0.0.0.11 - Improved security.
0.0.0.15 - Fixed serialization.
0.0.0.16 - Removed pagination properties from template, to be internally handled.
0.0.0.17 - Fixed blank responses and response objects being lost.

Connection

The Connection stores the ConnectWise base URL and credentials used by all methods.

Property	Type	Description
Site URL	String	The base URL of ConnectWise, e.g. https://example.connectwise.com.
Username	String	The ConnectWise user name used to authenticate requests.
Password	Masked	The password associated with the ConnectWise user name.

Setup Notes

This Node uses Basic Authentication with a ConnectWise API member and API key, as described in ConnectWise Manage Member Authentication.

1) Create an API Member

1. In ConnectWise Manage, open System -> Members -> API Members.
2. Click + to create a new API member.
3. Enter Flowgear in Member ID.
4. Enter an email address for your company.
5. Under System, select the Admin role or a custom security role with the permissions Flowgear needs.
6. Complete the remaining required fields. For fields that aren't required, feel free to leave these blank or choose the default setting.
7. Click Save.

2) Create an API Key

1. Select the API member you created for Flowgear, then open the API Keys tab.
2. Click + to create a new API key.
3. Enter Flowgear as the description, then click Save.
4. Copy the private key when it is shown. ConnectWise only displays it once.

3) Create the Connection

1. Enter your ConnectWise URL in Site URL, e.g. https://mycompany.myconnectwise.net.
2. Enter your company and API public key in Username, e.g. training+5QBrF9Eobsojjl19.
3. Enter the private key you created in Password, e.g. gNfvfMdPxIAPOIvB.

Methods

This Node exposes template-driven Query, Mutate, and Delete operations for ConnectWise resources.

Query

Retrieves ConnectWise resources.

• Query paging is handled internally, so paging Properties are not exposed.
• If you do not supply pageSize, the Node applies a default value internally.

Parameter	Type	Description
Connection	Connection	The ConnectWise Connection profile.
OperationId	String	The unique identifier for the selected operation to be performed.
Options	Object	Additional parameters required by the request.

Return	Type	Description
Response	Array	Normalized response items returned by the selected operation.

Mutate

Creates or updates ConnectWise resources.

Parameter	Type	Description
Connection	Connection	The ConnectWise Connection profile.
OperationId	String	The unique identifier for the selected operation to be performed.
Options	Object	Additional parameters required by the request.
Items	Array	Optional request body items.

Return	Type	Description
Response	Array	Normalized response items returned by the selected operation.

Delete

Deletes ConnectWise resources.

Parameter	Type	Description
Connection	Connection	The ConnectWise Connection profile.
OperationId	String	The unique identifier for the selected operation to be performed.
Options	Object	Additional parameters required by the request.
Items	Array	Optional request body items.

Return	Type	Description
Response	Array	Normalized response items returned by the selected operation.

Usage Notes

• Templates populate OperationId and the expected Options values for the selected operation.

Known Issues

• Binary responses are not currently supported.