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 manage WhatsApp sessions, specifically allowing users to start a WhatsApp session for a selected WhatsApp number (device). Starting a session is essential for enabling message sending and receiving through that WhatsApp number.

Common scenarios where this node is beneficial include:

Initializing or reinitializing a WhatsApp session before sending messages.
Managing multiple WhatsApp numbers by starting sessions on demand.
Automating session handling in workflows that require interaction with WhatsApp via SparkBot.

For example, a user can configure the node to start a session on a specific WhatsApp number and optionally wait until the session is fully available before proceeding with subsequent workflow steps.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) on which to start the session. Options are loaded dynamically from available devices.
Wait For Session	Boolean flag indicating whether to wait for the device session to become available before continuing. Waiting may delay the response up to 90 seconds.

Output

The node outputs JSON data representing the result of the session start operation. This typically includes information about the session status or confirmation that the session has started successfully.

No binary data output is produced by this node.

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" options are dynamically loaded, implying the node fetches available devices from the SparkBot API.

Troubleshooting

Session Start Delays: If "Wait For Session" is enabled, the node may take up to 90 seconds to respond. Users should be aware of this potential delay.
Invalid WhatsApp Number: Selecting a WhatsApp number that is not registered or unavailable may cause errors. Ensure the device ID is valid and active.
Authentication Errors: Missing or invalid API key credentials will prevent the node from communicating with the SparkBot API.
Network Issues: Connectivity problems with the SparkBot API endpoint can cause failures; verify network access and API availability.

Common error messages might include authentication failures, invalid device IDs, or timeouts waiting for session availability. Resolving these usually involves checking credentials, verifying device IDs, and ensuring network connectivity.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n Documentation on Creating Custom Nodes

SparkBotInstall