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, enabling various operations related to WhatsApp messaging and management. Specifically, for the WhatsApp session resource and the Get session health operation, it retrieves the current health status of a specified WhatsApp session (i.e., a WhatsApp number/device). This is useful for monitoring whether a WhatsApp session is active, connected, or experiencing issues.

Practical scenarios include:

Automatically checking if a WhatsApp number is ready to send/receive messages before attempting communication.
Monitoring multiple WhatsApp sessions in an automated workflow to detect and handle connection problems.
Integrating session health checks into alerting systems to notify administrators of session downtime.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number/device whose session health you want to check. This is selected from available devices loaded dynamically by the node.

Output

The node outputs a JSON object containing the session health information for the specified WhatsApp number. The exact structure depends on the API response but typically includes fields indicating connection status, uptime, last activity, or error states.

If the node supports binary data output (not indicated here), it would represent any associated files or media related to the session health, but this is not applicable for this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node dynamically loads available WhatsApp numbers/devices via a method named getDevices.
No additional external dependencies are indicated beyond the SparkBot API access.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp number/device ID: Ensure the device is correctly selected from the dropdown.
- Authentication errors: Verify that the API key credential is valid and has necessary permissions.
- Network or API connectivity problems: Check network access and SparkBot service status.
Error Messages:
- Errors returned from the API will be caught and can be output as JSON with an error field if "Continue On Fail" is enabled.
- Typical errors might include "Device not found," "Unauthorized," or "Session not active."
Resolutions:
- Re-authenticate or update API credentials.
- Confirm the WhatsApp number/device is registered and active in SparkBot.
- Retry after resolving network issues.

Links and References

SparkBot WhatsApp API Documentation (hypothetical link as no direct URL provided)
n8n Documentation on Creating Custom Nodes
General WhatsApp Business API concepts for session management.

SparkBotInstall