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 management. Specifically, for the Labels resource with the Get Labels operation, it retrieves the labels associated with a specified WhatsApp number (device). This is useful for organizing or categorizing chats or contacts within the WhatsApp environment managed by SparkBot.

Practical scenarios include:

Fetching all labels assigned to a particular WhatsApp number to display or process them in workflows.
Automating label-based routing or filtering of messages.
Integrating label data into CRM or support systems for better contact management.

Properties

Name	Meaning
WhatsApp number	The ID of the WhatsApp number (device) for which to retrieve labels. This must be selected from available devices loaded dynamically.

Output

The node outputs an array of JSON objects representing the labels retrieved for the specified WhatsApp number. Each object corresponds to a label with its properties as returned by the SparkBot API.

The output structure under the json field typically includes label details such as label ID, name, and possibly other metadata depending on the API response.

No binary data output is involved in this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot service being accessible and the provided WhatsApp number (device) being valid and active.
The property "WhatsApp number" uses a dynamic options loader method to fetch available devices, so proper configuration and permissions are needed for that.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID will cause the operation to fail.
- Network or authentication errors if the API key is incorrect or expired.
- No labels found if the WhatsApp number has no labels assigned.
Error messages:
- Errors from the API will be surfaced with their message; ensure the WhatsApp number exists and the API key is valid.
- If the node throws an error about loading devices, check the credentials and network connectivity.
Resolution tips:
- Verify the WhatsApp number ID is correct and currently registered in SparkBot.
- Confirm the API key credential is properly set up and has necessary permissions.
- Use the "Continue On Fail" option to handle cases where some inputs might not return labels without stopping the entire workflow.

Links and References

SparkBot WhatsApp API Documentation (generic link, replace with actual if available)
n8n documentation on Creating Custom Nodes
General info on WhatsApp Business API labeling features for context.

SparkBotInstall