SparkBotInstall

Overview

This node interacts with the SparkBot WhatsApp API to retrieve detailed information about a specific chat associated with a WhatsApp number. It is particularly useful for scenarios where you need to fetch comprehensive data about a chat, including its messages, notes, and participants, enabling deeper insights or further automation based on chat content.

Practical examples include:

• Fetching all messages from a customer support chat to analyze conversation history.
• Retrieving participant details in a group chat for management or reporting.
• Accessing notes attached to a chat for context before responding or escalating.

Properties

Output

The node outputs a JSON object containing detailed information about the specified chat. Depending on the "Include Items" selection, the output may include:

• Chat metadata: Basic information about the chat such as ID, status, timestamps, etc.
• Messages: An array of message objects exchanged in the chat.
• Notes: Any notes attached to the chat.
• Participants: Details about users participating in the chat (especially relevant for group chats).

If binary data were involved (e.g., media files), it would be summarized accordingly, but this operation focuses on JSON data representing chat details.

Dependencies

• Requires an API key credential for authenticating with the SparkBot WhatsApp API.
• The node depends on the SparkBot service being accessible and properly configured.
• No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

• Common issues:

  • Invalid or missing WhatsApp number (device) ID can cause failures in retrieving chat data.
  • Incorrect or malformed Chat ID will result in errors or empty responses.
  • Network or authentication errors if the API key is invalid or the SparkBot service is unreachable.

• Error messages:

  • Errors returned by the API typically include descriptive messages; ensure the WhatsApp number and Chat ID are correct.
  • If the node throws an error about missing parameters, verify that all required fields are filled.
  • For permission-related errors, check that the API key has sufficient rights to access chat details.

• Resolution tips:

  • Double-check the WhatsApp number and Chat ID formats.
  • Confirm the API key is valid and has not expired.
  • Use the "Include Items" property judiciously to avoid overly large responses that might time out.

Links and References

• SparkBot WhatsApp API Documentation (general reference for API capabilities)
• n8n documentation on Creating Custom Nodes
• WhatsApp chat ID format explanation: user chats end with @c.us, group chats end with @g.us