ConnectWise Manage

Overview

This node integrates with the ConnectWise Manage API to perform various operations on different resources within the ConnectWise system. Specifically, for the Document resource and the Download operation, it allows users to download a document by its ID from ConnectWise Manage.

Common scenarios where this node is beneficial include:

• Automating retrieval of documents stored in ConnectWise Manage for further processing or archival.
• Integrating document downloads into workflows that require access to attachments or files related to tickets, projects, or other entities managed in ConnectWise.
• Enabling downstream nodes in n8n workflows to use the downloaded document data, such as sending it via email or saving it to cloud storage.

Example usage:

• A workflow triggers when a ticket is updated, then downloads an associated document by its Document ID for review or backup.
• Periodic workflows that archive all documents from ConnectWise Manage by downloading them and storing externally.

Properties

Output

The output contains both JSON metadata and binary data representing the downloaded document:

• json: An object with the following fields:

  • documentId: The ID of the downloaded document.
  • fileName: The filename as provided by the server (extracted from the HTTP response headers).
  • mimeType: The MIME type of the downloaded file.

• binary: Contains the actual file data under the key data. This binary data can be used by subsequent nodes to save the file, send it, or process it further.

Dependencies

• Requires an active connection to the ConnectWise Manage API using an API authentication credential configured in n8n.
• The node uses the base URL from the credential's site URL to construct API requests.
• The API must support the /system/documents/{documentId}/download endpoint for downloading documents.

Troubleshooting

• Missing Document ID: If the Document ID parameter is not provided or invalid, the node will throw an error indicating the missing or invalid parameter.
• API Request Failures: Network issues, incorrect credentials, or insufficient permissions may cause API request failures. The node logs detailed error responses from ConnectWise Manage to help diagnose issues.
• File Download Issues: If the document cannot be downloaded (e.g., due to permissions or non-existent document), the node will throw an error with the API's response message.
• Binary Data Preparation: Errors during binary data preparation are possible if the response is malformed or empty; ensure the document exists and is accessible.

To resolve errors:

• Verify the Document ID is correct and the document exists in ConnectWise Manage.
• Check that the API credentials have sufficient permissions to access and download documents.
• Review network connectivity and API endpoint availability.
• Enable debug logging in n8n to see detailed request and response information.

Links and References

• ConnectWise Manage API Documentation
• n8n Documentation on Binary Data Handling
• ConnectWise Manage System Documents Endpoint (for reference on the download endpoint)