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 manage WhatsApp groups. Specifically, the Get Pending Members operation under the Groups resource retrieves the list of members who have requested to join a specified WhatsApp group but are still pending approval. This is useful for administrators or moderators who want to review and manage membership requests before allowing users into the group.

Practical examples:

A community manager wants to see all pending join requests to approve or reject them.
An automated workflow that fetches pending members periodically to notify admins via another channel.
Auditing group membership requests for compliance or moderation purposes.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the group is managed.
Group ID	The unique identifier of the WhatsApp group whose pending members you want to retrieve.

WhatsApp Number options are dynamically loaded from available devices linked to the account.
Group ID options depend on the selected WhatsApp Number and represent groups associated with that device.

Output

The output JSON contains the data returned by the SparkBot API for the pending members of the specified group. Typically, this includes an array of user objects representing each pending member, with details such as their WhatsApp ID, name, and possibly the timestamp of their join request.

If the node supports binary data output (not indicated here), it would typically relate to media files or attachments, but for this operation, the output is purely JSON-based member information.

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n to authenticate requests.
Dynamic loading of WhatsApp numbers and groups depends on the API endpoints provided by SparkBot.
Proper permissions on the WhatsApp number to access group information.

Troubleshooting

Common issues:
- Invalid or expired API key leading to authentication errors.
- Selecting a WhatsApp number without any associated groups will result in no data or errors.
- Network connectivity problems causing timeouts or failed API calls.
- Insufficient permissions on the WhatsApp number to query group members.
Error messages:
- "Authentication failed": Check that the API key credential is correctly set and valid.
- "Group not found": Verify the Group ID is correct and belongs to the selected WhatsApp number.
- "No pending members": The group currently has no pending join requests.
- "Request timed out": Ensure network connectivity and API availability.

Resolving these usually involves verifying credentials, checking input parameters, and ensuring the SparkBot service is operational.

Links and References

SparkBot WhatsApp API Documentation (generic link, replace with actual if available)
n8n documentation on Creating Custom Nodes
WhatsApp Business API official docs for understanding group management concepts: https://developers.facebook.com/docs/whatsapp/api/groups

Note: This summary is based solely on static analysis of the provided source code and property definitions. Runtime behavior may vary depending on API responses and environment configuration.

SparkBotInstall