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 query the business catalog associated with a WhatsApp Business account. Specifically, it allows users to retrieve product items listed in the business catalog of a given WhatsApp Business phone number.

Common scenarios where this node is beneficial include:

Retrieving and displaying product catalogs within automated WhatsApp conversations.
Integrating WhatsApp Business product listings into CRM or e-commerce platforms.
Automating inventory checks or updates by querying the catalog programmatically.

For example, a user can input their WhatsApp Business phone number and specify how many products they want to retrieve (up to 500). The node then returns the catalog data, which can be used downstream for messaging customers about available products.

Properties

Name	Meaning
WhatsApp Number	The ID of your WhatsApp Business number (device identifier).
Business Phone Number	The phone number of the WhatsApp Business account to query (e.g., +1234567890).
Products to Return	Number of catalog product items to retrieve, with a maximum limit of 500 (default 100).

Output

The node outputs JSON data representing the queried business catalog products. Each item in the output corresponds to a product entry from the WhatsApp Business catalog, including details such as product name, description, price, and other relevant metadata provided by the SparkBot API.

No binary data output is indicated for 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 properly configured.
The "WhatsApp Number" property must correspond to a valid device registered with the SparkBot API.
Proper network connectivity to the SparkBot API endpoints is necessary.

Troubleshooting

Common Issues:
- Invalid or missing API key credential will cause authentication failures.
- Incorrect or unregistered WhatsApp Business phone number may result in empty or error responses.
- Requesting more than 500 products will likely cause validation errors.
- Network issues or API downtime can lead to request timeouts or failures.
Error Messages:
- Authentication errors typically indicate invalid or expired API keys; verify and update credentials.
- Validation errors on input parameters suggest checking the phone number format and product count limits.
- If the node returns an error message wrapped in JSON under error, enabling "Continue On Fail" can help debug without stopping workflows.

Links and References

WhatsApp Business Catalog API Documentation
SparkBot WhatsApp API Overview
n8n Documentation on Creating Custom Nodes

SparkBotInstall