SparkBotInstall

Overview

This node interacts with the SparkBot WhatsApp API to perform various operations related to WhatsApp groups. Specifically, the Get Invite Code operation under the Groups resource retrieves the invite code for a specified WhatsApp group associated with a particular WhatsApp number (device). This is useful when you want to programmatically obtain the invite link or code to share with others for joining a group.

Common scenarios:

• Automating the retrieval of group invite codes to distribute them via other communication channels.
• Managing multiple WhatsApp groups and needing quick access to their invite links.
• Integrating WhatsApp group management into broader workflows, such as CRM or marketing automation.

Example:
You have a WhatsApp number connected to SparkBot and want to get the invite code for a specific group to send it in an email campaign automatically.

Properties

Output

The output JSON contains the data returned by the SparkBot API for the group invite code request. Typically, this includes the invite code or link that can be shared to allow others to join the group.

If the node supports binary data output (not explicitly shown here), it would represent any files or media related to the group invite, but for this operation, the output is primarily JSON with invite code details.

Dependencies

• Requires an active connection to the SparkBot WhatsApp API.
• Needs an API key credential configured in n8n to authenticate requests.
• The node depends on dynamic loading of WhatsApp numbers ("devices") and groups based on the selected device.

Troubleshooting

• Common issues:

  • Invalid or missing WhatsApp number/device ID: Ensure the device exists and is correctly selected.
  • Incorrect group ID: Verify the group ID format and that the group belongs to the selected WhatsApp number.
  • API authentication errors: Confirm the API key credential is valid and has necessary permissions.
  • Network or connectivity problems with the SparkBot API.

• Error messages:

  • "error": "Invalid group ID" — Check the group ID input.
  • "error": "Unauthorized" — Verify API key credentials.
  • "error": "Device not found" — Make sure the WhatsApp number/device is available and properly loaded.

Resolving these usually involves verifying inputs, refreshing credentials, or checking network connectivity.

Links and References

• SparkBot WhatsApp API Documentation (example placeholder, replace with actual URL if known)
• n8n documentation on Creating Custom Nodes
• WhatsApp Group Invite Links info: https://faq.whatsapp.com/general/chats/about-group-invite-links/

Note: Internal credential names and implementation details are abstracted to maintain security and clarity.