SparkBotInstall

Overview

This node interacts with the SparkBot WhatsApp API, providing various operations related to WhatsApp messaging and management. Specifically, for the Files resource with the Get File operation, it retrieves a file by its unique identifier from outbound files managed by the SparkBot service.

Common scenarios where this node is beneficial include:

• Downloading or previewing media files sent or received via WhatsApp through SparkBot.
• Accessing stored outbound files for processing, archiving, or further automation workflows.
• Integrating WhatsApp file retrieval into broader business processes such as customer support or marketing campaigns.

For example, you might use this node to fetch an image or document sent to a customer and then attach it to a CRM record or send it via email.

Properties

Output

The node outputs JSON data representing the retrieved file's details. This typically includes metadata about the file such as its name, type, size, and possibly a URL or binary content reference depending on the API response.

If the node supports binary data output (not explicitly shown in the provided code), it would represent the actual file content, allowing downstream nodes to process or save the file.

Dependencies

• Requires an API key credential for authenticating with the SparkBot WhatsApp API.
• The node depends on the SparkBot service being accessible and the API key having permissions to access outbound files.
• No additional environment variables are indicated beyond the API key credential.

Troubleshooting

• File Not Found: If the specified File ID does not exist or is incorrect, the node will likely throw an error indicating the file could not be found. Verify the File ID is correct and corresponds to an existing outbound file.
• Authentication Errors: Missing or invalid API key credentials will cause authentication failures. Ensure the API key is correctly configured in n8n credentials.
• Permission Issues: The API key must have sufficient permissions to access outbound files; otherwise, access will be denied.
• Network or API Downtime: Connectivity issues or SparkBot API downtime can cause request failures. Check network connectivity and SparkBot service status.

When errors occur, if "Continue On Fail" is enabled, the node returns an error object in the output JSON instead of stopping the workflow.

Links and References

• SparkBot WhatsApp API Documentation (example placeholder, replace with actual URL if available)
• n8n Documentation on Creating Custom Nodes