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, providing various operations grouped by resource types. Specifically for the Webhooks resource and the Get Webhook operation, it allows users to retrieve details about a specific webhook by its ID. This is useful in scenarios where you need to inspect or manage existing webhooks configured in your SparkBot WhatsApp integration.

Practical examples include:

Fetching webhook configuration details to verify URL endpoints or event subscriptions.
Debugging webhook issues by retrieving current webhook settings.
Automating management tasks that require reading webhook data before updating or deleting them.

Properties

Name	Meaning
Webhook ID	The unique identifier of the webhook to retrieve. This is required to specify which webhook's details should be fetched.

Output

The node outputs JSON data representing the webhook's details as returned by the SparkBot WhatsApp API. This typically includes information such as the webhook's ID, URL, subscribed events, status, and other metadata related to the webhook configuration.

If the node supports binary data output (not indicated here), it would represent any files or attachments related to the webhook, but this is not applicable for the Get Webhook operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
Needs network access to the SparkBot API endpoints.
No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

Common Issues:
- Providing an invalid or empty Webhook ID will likely result in an error from the API indicating the webhook was not found.
- Network connectivity problems can cause request failures.
- Insufficient permissions or incorrect API key may lead to authorization errors.
Error Messages:
- "Webhook not found": Verify the Webhook ID is correct and exists.
- "Unauthorized" or "Invalid API key": Check that the API key credential is valid and has necessary permissions.
- Timeout or network errors: Ensure the node can reach the SparkBot API endpoint.

Resolving these usually involves verifying input parameters, checking credentials, and ensuring stable network connectivity.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n documentation on Creating Custom Nodes

SparkBotInstall