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 perform various operations related to WhatsApp messaging and team management. Specifically, for the Team resource and the Get Device Team Members operation, it retrieves the list of team members associated with a particular WhatsApp number (device). This is useful in scenarios where you want to manage or audit which users have access to a specific WhatsApp device within your organization.

Practical examples:

Fetching all team members who can send messages from a given WhatsApp number.
Auditing user permissions on WhatsApp devices before granting or revoking access.
Integrating team member data into workflows that automate user management or reporting.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) for which to get the associated team members. This is selected from a list of available WhatsApp numbers loaded dynamically.

Output

The output is a JSON object containing the details of the team members associated with the specified WhatsApp number. Each item in the output array represents a team member with their relevant information as returned by the SparkBot API.

If the node supports binary data output (not indicated here), it would typically represent files or media related to the team members, but this operation focuses on JSON data about users.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot API service being accessible and properly configured.
The "WhatsApp Number" property dynamically loads options via an internal method (getDevices), which requires connectivity to the API to fetch available devices.

Troubleshooting

Common issues:
- Invalid or missing API key credential will cause authentication failures.
- Specifying a WhatsApp number that does not exist or is not linked to the account will result in errors or empty results.
- Network connectivity problems may prevent loading WhatsApp numbers or retrieving team members.
Error messages:
- Authentication errors: Check that the API key credential is correctly set up and has necessary permissions.
- "Device not found" or similar: Verify the WhatsApp number ID is correct and active.
- Timeout or network errors: Ensure stable internet connection and that the SparkBot API endpoint is reachable.

Links and References

SparkBot WhatsApp API Documentation (hypothetical link)
n8n documentation on creating custom nodes
General WhatsApp Business API concepts for understanding device and team member management.

SparkBotInstall