SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node integrates with the SparkBot WhatsApp API to perform various operations related to WhatsApp messaging and management. Specifically, for the Files resource with the Download File operation, it allows users to download files that have been sent or received via WhatsApp through the SparkBot platform.

Common scenarios where this node is beneficial include:

  • Automatically retrieving media files (images, documents, videos) shared in WhatsApp conversations for backup or processing.
  • Integrating WhatsApp file downloads into workflows such as CRM updates, document management systems, or content moderation pipelines.
  • Archiving outbound files sent through WhatsApp for compliance or auditing purposes.

Practical example:

  • A user configures the node to download a specific file by its ID after receiving a notification about a new file shared in a WhatsApp chat, then stores the file in cloud storage or attaches it to a customer record.

Properties

Name Meaning
File ID The unique identifier of the file to download. This ID is selected from available files.

Output

The node outputs JSON data representing the downloaded file's details and content. Typically, this includes metadata about the file and the file data itself.

If the file is binary (e.g., image, video, document), the node will output the file in the binary property of the item, allowing subsequent nodes to handle or save the file appropriately.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • Needs network access to the SparkBot API endpoints.
  • The node depends on internal methods that handle the actual API calls to download files.

Troubleshooting

  • File not found or invalid File ID: Ensure the File ID provided exists and is accessible. Use the file selection dropdown populated by the getFiles method to avoid typos.
  • Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network issues: Check connectivity to the SparkBot API service.
  • Binary data handling: If subsequent nodes fail to process the binary file, confirm that the binary data is correctly passed and that the following nodes support binary input.

Links and References

Discussion