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 messaging and management. Specifically, for the Files resource with the Get File Preview operation, it retrieves a preview of an outbound file by its ID. This is useful when you want to quickly access or display a thumbnail or preview version of a file sent through WhatsApp without downloading the entire file.

Practical scenarios include:

Displaying image or document previews in dashboards or apps before full download.
Verifying file content or metadata visually.
Integrating file previews into automated workflows for approvals or reviews.

Properties

Name	Meaning
File ID	The unique identifier of the outbound file to retrieve a preview for. This must be a valid file ID obtained from previous operations or listings.

Output

The node outputs JSON data representing the file preview information. This typically includes metadata and possibly a URL or base64 encoded preview content that can be used to render a thumbnail or small version of the file.

If the node supports binary data output (not explicitly shown in the code), it would represent the actual preview content (e.g., image bytes) suitable for direct use or saving.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot API endpoints for outbound files.
Proper configuration of the API key credential within n8n is necessary.
The File ID must correspond to an existing outbound file accessible via the API.

Troubleshooting

Invalid File ID: If the provided File ID does not exist or is incorrect, the node will likely throw an error indicating the file was not found. Verify the File ID is correct and corresponds to an outbound file.
Authentication Errors: Missing or invalid API key credentials will cause authentication failures. Ensure the API key is correctly configured and has sufficient permissions.
API Rate Limits: Excessive requests may lead to rate limiting by the SparkBot API. Implement retry logic or reduce request frequency.
Network Issues: Connectivity problems can cause timeouts or failed requests. Check network status and proxy settings if applicable.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n documentation on Creating Custom Nodes
n8n community forums for troubleshooting and examples

Note: The summary is based on static analysis of the bundled source code and provided property definitions. Runtime behavior depends on the external SparkBot API responses and proper credential setup.

SparkBotInstall