Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the Connect Secure API to download reports. Specifically, for the "Reports" resource and the "Download Report" operation, it allows users to retrieve a report file based on a job identifier. This is useful in scenarios where automated workflows need to fetch generated reports from an external system for further processing, archiving, or analysis.

Practical examples include:

  • Automatically downloading daily or weekly reports after they are generated.
  • Fetching specific job-related reports on demand within a workflow.
  • Integrating report retrieval into larger automation pipelines that process or distribute report data.

Properties

Name Meaning
X USER ID The user identifier required by the API, sent as a custom header X-USER-ID.
Job Id The unique identifier of the report job to download; sent as a query parameter job_id.
Is Global Boolean flag indicating whether the report is global; sent as a query parameter isGlobal.

Output

The node outputs the downloaded report data in the json output field. Since this is a report download operation, the output likely contains the raw report content or metadata about the downloaded file. If the report is binary (e.g., PDF, Excel), the node would typically provide this as binary data attached to the output item, enabling downstream nodes to handle or save the file accordingly.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the external Connect Secure API service being accessible.
  • No additional environment variables or configurations are explicitly required beyond the API authentication setup.

Troubleshooting

  • Missing or invalid X USER ID header: Ensure the user ID is correctly provided and matches what the API expects.
  • Invalid or missing job_id: The job identifier must be valid and correspond to an existing report job; otherwise, the API may return errors or empty responses.
  • API authentication failures: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network or connectivity issues: Confirm that the n8n instance can reach the Connect Secure API endpoint.
  • Incorrect isGlobal value: Passing an incorrect boolean might result in unexpected report retrieval behavior.

Common error messages will generally relate to authorization failures, missing parameters, or resource not found errors. Checking the input properties and API credentials usually resolves these issues.

Links and References

  • Connect Secure API documentation (refer to official docs for detailed API usage)
  • n8n documentation on creating and using HTTP request nodes and handling binary data

Discussion