SparkBot

Interact with SparkBot WhatsApp API

Actions148

Chats Actions
- Archive Chat
- Unarchive Chat
- Delete Chat
- Bulk Update Chats
- Get Chats
- Get Chat Details
- Send Typing Status
- Sync Device Chats
- Sync Chat Messages
- Update Chat Read Status
- Set Chat Status
- Get Group Participants
- Assign Chat
- Unassign Chat
- Create Chat Note
- Delete Chat Note
- Update Chat Labels
- Update Chat Attributes
Chat Contacts Actions
- Get Contacts
- Get Contact Details
- Create Contact
- Update Contact
- Update Contact Metadata
- Upsert Contact Metadata
- Delete Contact
- Bulk Create Contacts
- Block Contacts
- Unblock Contacts
Chat Messages Actions
- Get Messages
- Get Message Details
- Get Message Delivery Info
- Edit Message
- Delete Message
Chat Files Actions
- Get Files
- Get File Details
- Download File
Files Actions
- Delete Files
- Search Files
- Upload File
- Get File Preview
- Download File
- Get File
- Update File
- Delete File
Team Actions
- Get Team Members
- Update Team Member
- Delete Team Members
- Get Device Team Members
- Create Team Member
- Grant Device Access
- Revoke Device Access
Labels Actions
- Get Labels
- Create Label
- Update Label
- Delete Label
Departments Actions
- Get Departments
- Create Department
- Update Department
- Delete Department
Quick replies Actions
- Get Quick Replies
- Create Quick Reply
- Update Quick Reply
- Delete Quick Replies
Queue Actions
- Get Queue Status
- Set Queue Status
- Route Queue
- Empty Queue
WhatsApp session Actions
- Sync session
- Start session
- Scan QR
- Reset session
- Reboot session
- Get session health
- Request Authentication Code
WhatsApp profile Actions
- Get Profile
- Update Profile
- Get Profile Image
- Update Profile Image
Business catalog Actions
- Get My Catalog
- Query Business Catalog
Campaigns Actions
- Get Campaigns
- Get Campaign
- Update Campaign Status
- Get Campaign Contacts
- Delete Campaign
Meeting Links Actions
- Get Meeting Links
- Create Meeting Link
- Delete Meeting Links
User Status Actions
- Get User Status
- Get User Status by ID
- Update User Status
- Delete User Status
Webhooks Actions
- Get Webhooks
- Create Webhook
- Get Webhook
- Update Webhook
- Delete Webhook
- Enable Webhook
- Get Webhook Logs
Other Actions
- Verify number exists
- Validate phone numbers
- Send API request
Send messages Actions
- Send text message
- Send multimedia message
- Send scheduled message
- Send poll message
- Send votes in a poll
- Delete votes in a poll
- Send meeting event
- Send meeting confirmation
- Send location
- Send contacts
- Send reaction
- Send catalog product
- Forward message
Outbound Messages Actions
- Search Messages
- Get Message
- Update Message
- Delete Message
WhatsApp Numbers Actions
- Get Numbers
- Get Number by ID
- Create Number
- Update Number
- Delete Number
- Delete Chats
Groups Actions
- Get Groups
- Get Group
- Create Group
- Update Group
- Update Group Image
- Add Participants
- Update Participants
- Remove Participants
- Get Pending Members
- Approve Members
- Reject Members
- Get Invite Code
- Revoke Invite Code
- Join Group
- Leave Group
Channels Actions
- Get Channels
- Get Channel
- Create Channel
- Update Channel
- Update Channel Image
- Delete Channel
- Join Channel
- Search Channels

Overview

This node interacts with the SparkBot WhatsApp API to retrieve detailed information about a specific WhatsApp group. It is useful when you need to programmatically access metadata or settings of a WhatsApp group associated with a particular WhatsApp number managed via SparkBot.

Common scenarios include:

Fetching group details for monitoring or reporting purposes.
Integrating group information into CRM or customer support workflows.
Automating group management tasks by first retrieving current group data.

For example, you might use this node to get the name, description, or participant list of a WhatsApp group before sending targeted messages or updating group settings.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the group is managed. This selects the WhatsApp account context.
Group ID	The unique identifier of the WhatsApp group to retrieve information about. Examples: `447362053576-1500000000` or `447362053576-1500000000@g.us`.

Output

The node outputs a JSON object containing the details of the specified WhatsApp group as returned by the SparkBot API. This typically includes group metadata such as:

Group name
Group description
List of participants
Group creation date
Other relevant group settings and status information

No binary data output is expected from this operation.

Dependencies

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

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number (device) selection may cause failure to load groups.
- Incorrect or expired API key will result in authentication errors.
- Specifying a non-existent or inaccessible Group ID will lead to errors indicating the group was not found.
Error messages and resolutions:
- "Group not found": Verify that the Group ID is correct and belongs to the selected WhatsApp number.
- "Authentication failed": Check that the API key credential is valid and has necessary permissions.
- "Failed to load devices/groups": Ensure the SparkBot service is reachable and the account has active WhatsApp numbers and groups.

Links and References

SparkBot WhatsApp API Documentation (for detailed API capabilities and group data structure)
n8n documentation on Creating Custom Nodes

SparkBotInstall