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 quick replies associated with a specified WhatsApp number. Quick replies are predefined message templates that can be used to respond rapidly in WhatsApp conversations, improving efficiency and consistency in communication.

Typical use cases include:

Customer support teams fetching available quick replies to automate or assist in responding to common queries.
Marketing or sales teams retrieving quick reply templates filtered by scope or permissions to ensure appropriate messaging.
Managing and displaying quick replies dynamically within workflows based on agent or permission filters.

For example, a user might configure this node to get all public quick replies synced with their WhatsApp Business account or fetch private quick replies created by specific agents for targeted responses.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number from which to retrieve quick replies. This identifies the device/account context for the query.
Filters	A collection of optional filters to narrow down the quick replies returned:
- Scope	Filter quick replies by definition scope. Options: • WhatsApp Business Synced • Chat Created
- Permissions	Filter quick replies by permission level. Multiple selections allowed. Options: • Public • Read-only • Private
- Agents	Filter quick replies created by specific agent IDs. Accepts multiple values.
- Results Page Size	Maximum number of results per page (pagination). Default is 20.
- Page Number	Page number to retrieve, starting from 0 (pagination). Default is 0.

Output

The node outputs an array of JSON objects representing the quick replies matching the specified filters. Each object contains details about a quick reply such as its content, scope, permissions, creator (agent), and other metadata as provided by the SparkBot API.

No binary data output is produced by this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API via an API key credential configured in n8n.
The node depends on the SparkBot service being accessible and the WhatsApp number/device ID being valid and authorized.
Pagination parameters allow handling large result sets efficiently.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number/device ID will cause the API call to fail.
- Incorrect or insufficient API credentials may lead to authentication errors.
- Using filters with invalid values (e.g., unknown agent IDs) might return empty results or errors.
- Pagination parameters out of range could result in no data returned.
Error messages:
- Authentication failures: Check that the API key credential is correctly set up and has necessary permissions.
- Resource not found or invalid device ID: Verify the WhatsApp number ID is correct and linked to your SparkBot account.
- API rate limits or connectivity issues: Ensure network access and consider retrying after some time.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n Documentation on Credentials (for setting up API keys)
WhatsApp Business API Overview (context on WhatsApp business messaging)

SparkBotInstall