ConnectWise Manage

Overview

This node integrates with the ConnectWise Manage API to perform various operations on different resources within ConnectWise Manage. Specifically, for the Configuration resource and the Search operation, it allows users to search configurations based on a query string with optional ordering and pagination controls.

Typical use cases include:

• Searching configuration items in ConnectWise Manage by specific criteria (e.g., name, status).
• Retrieving filtered lists of configurations for reporting or automation workflows.
• Integrating configuration data into other systems or processes by fetching relevant configuration records dynamically.

For example, a user might want to find all configurations related to a particular product or client, ordered by their ID descending, to process or analyze them further in an automated workflow.

Properties

Note: The "Order By" property supports specifying any valid field name recognized by the ConnectWise Manage API for ordering results.

Output

The node outputs JSON data representing the list of configuration objects matching the search criteria. Each item corresponds to a single configuration record retrieved from ConnectWise Manage.

• The output JSON structure directly reflects the API response for configurations.
• If multiple configurations match, each will be output as a separate item.
• No binary data is produced for this operation.

Example output snippet (simplified):

{
  "configurationId": 123,
  "name": "Configuration Name",
  "description": "Description of the configuration",
  ...
}

Dependencies

• Requires an active connection to the ConnectWise Manage API.
• Needs an API authentication credential configured in n8n (an API key or token) to authorize requests.
• The node uses the base URL of the ConnectWise Manage instance provided in credentials.
• The API version targeted is v4_6_release/apis/3.0.

Troubleshooting

• Missing or invalid credentials: Ensure that the API key/token and site URL are correctly configured in the node credentials.
• Invalid search query: The search query must be a valid ConnectWise Manage API conditions string; otherwise, the API may return errors or empty results.
• Unsupported operation error: If the operation or resource is not supported, the node throws an error indicating so.
• API request failures: Network issues or incorrect permissions can cause request failures. Check API access rights and network connectivity.
• Empty results: If no configurations match the search query, the node returns an empty array without error.

Links and References

• ConnectWise Manage API Documentation
• ConnectWise Manage API - Configurations Endpoint
• n8n Documentation - Creating Custom Nodes