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, specifically providing operations related to managing webhooks. The "Get Webhook Logs" operation retrieves log entries for a specified webhook, allowing users to monitor and audit webhook activity.

Common scenarios where this node is beneficial include:

Debugging webhook events by reviewing recent logs.
Auditing webhook calls to ensure expected behavior.
Monitoring webhook usage and troubleshooting issues in integrations.

For example, a user can specify a webhook ID and retrieve the last 20 log entries to see what data was sent or received through that webhook.

Properties

Name	Meaning
Webhook ID	The unique identifier of the webhook for which to retrieve logs.
Options	Additional parameters to control the log retrieval:
- Maximum Entries (size)	The maximum number of log entries to retrieve (default is 20).
- Skip Entries (skip)	The number of log entries to skip from the start (default is 0).

Output

The output contains a JSON array of webhook log entries corresponding to the specified webhook ID. Each entry typically includes details such as timestamps, event data, status, and any relevant metadata about the webhook invocation.

If the node supports binary data output (not explicitly shown here), it would represent raw payloads or attachments related to webhook events.

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 webhook ID will cause errors or empty results.
- Network connectivity problems may prevent retrieving logs.
- Exceeding API rate limits could result in temporary failures.
Error Messages:
- Errors indicating authentication failure suggest checking the API key credential.
- Errors about invalid parameters usually mean the webhook ID or options are incorrect.
- Timeout or network errors require verifying internet connection and API availability.

To resolve these issues, verify the webhook ID is correct, ensure the API key is valid and has necessary permissions, and check network connectivity.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n documentation on creating custom nodes (for extending or debugging nodes)

SparkBotInstall