HumanFirstInstall

Overview

This node integrates with the HumanFirst platform to run a full pipeline workflow on a specified playbook and pipeline. It triggers the pipeline execution, waits for its completion, then exports the processed data in either JSON or CSV format. This is useful for automating complex data processing workflows defined in HumanFirst playbooks, such as conversation analysis pipelines or data enrichment tasks.

Typical use cases include:

• Triggering a predefined data processing pipeline on conversational data.
• Exporting the results of the pipeline for further analysis or reporting.
• Automating data workflows that require waiting for asynchronous pipeline completion before retrieving results.

For example, you might use this node to trigger a conversation analysis pipeline on a set of chat logs, wait until the pipeline finishes processing, and then download the enriched data as JSON or CSV for downstream processing.

Properties

Output

The node outputs one item containing:

• json:

  • exportId: The identifier of the export operation.
  • pipelineId: The pipeline that was run.
  • download_url: A URL to download the exported data (if "Download URL" option selected).
  • texts: An array of text strings extracted from the export (if "List of Texts" option selected).
  • triggerStatus: Status of the pipeline trigger (should be "TRIGGER_STATUS_COMPLETED" on success).

• binary (optional):

  • If the "Download URL" return option is selected, the exported file content is provided as binary data named file.
  • The binary data contains the exported pipeline output in the chosen format (JSON or CSV).
  • The filename is auto-generated with a timestamp and appropriate extension (.json or .csv).
  • MIME type corresponds to the format (application/json or text/csv).

Dependencies

• Requires an API key credential for authenticating with the HumanFirst API.
• The node makes HTTP requests to the HumanFirst API endpoints to trigger pipelines, poll for status, and retrieve export data.
• No additional external dependencies beyond the HumanFirst API and n8n's built-in HTTP request helper.

Troubleshooting

• No triggerId returned: If the initial pipeline trigger response does not contain a triggerId, the node throws an error. Ensure the playbook and pipeline IDs are correct and the API key has sufficient permissions.

• Pipeline did not succeed: If the pipeline status becomes FAILED or CANCELLED, the node throws an error indicating the pipeline did not complete successfully. Check the pipeline configuration and logs in HumanFirst.

• No exportUrlPath in response: If the export request does not return a valid URL path, the node throws an error. Verify that the pipeline completed successfully and that the export parameters are correct.

• Invalid returnOption: If an unsupported return option is specified, the node throws an error. Use only the supported options: "Download URL" or "List of Texts".

• API authentication errors: Ensure the API key credential is valid and has access to the specified namespace, playbook, and pipeline.

• Timeouts during polling: The node polls the pipeline status every 15 seconds indefinitely until completion or failure. Network issues or very long-running pipelines may cause delays.

Links and References

• HumanFirst API Documentation
• n8n Expressions Documentation
• HumanFirst Platform

If you need details about other operations or resources, please provide their names.