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 integrates with the SparkBot WhatsApp API to perform various operations related to WhatsApp business management. Specifically, for the Departments resource and the Get Departments operation, it retrieves a list of departments associated with a specified WhatsApp number (device). This is useful for businesses that organize their customer support or sales teams into departments and want to programmatically access department information linked to their WhatsApp numbers.

Practical examples:

Automatically fetching all departments for a given WhatsApp number to display in a dashboard.
Using department data to route incoming WhatsApp messages to the correct team.
Synchronizing department lists with other CRM or helpdesk systems.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) for which to retrieve the associated departments.

Output

The node outputs an array of JSON objects representing the departments linked to the specified WhatsApp number. Each object typically contains details about a department such as its identifier, name, and possibly other metadata defined by the SparkBot API.

If the node encounters an error during execution and "Continue On Fail" is enabled, the output will contain an object with an error field describing the issue.

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.
No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID: Ensure the provided device ID corresponds to a valid WhatsApp number registered in SparkBot.
- Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
- Network or API downtime: Check connectivity and SparkBot service status.
Error messages:
- Errors returned from the API will be surfaced in the node's output if "Continue On Fail" is enabled.
- Typical error messages might include "Unauthorized", "Device not found", or "Internal server error".
Resolution tips:
- Double-check input parameters for correctness.
- Re-authenticate or update the API key credential if authentication fails.
- Retry after some time if the API service is temporarily unavailable.

Links and References

SparkBot WhatsApp API Documentation (general reference for API endpoints and usage)
n8n documentation on creating custom nodes for further customization guidance

SparkBotInstall