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

The node integrates with the SparkBot WhatsApp API, enabling various operations related to WhatsApp messaging and management. Specifically, for the Webhooks resource and the Enable Webhook operation, it allows users to activate a webhook by its ID. This is useful in scenarios where you want to start receiving real-time event notifications from the SparkBot platform via webhooks, such as message delivery updates or incoming messages.

Practical examples include:

Enabling a webhook after creating it to start receiving WhatsApp event callbacks.
Reactivating a previously disabled webhook without recreating it.
Managing webhook lifecycle programmatically within an automation workflow.

Properties

Name	Meaning
Webhook ID	The unique identifier of the webhook to enable. This must be provided to specify which webhook should be activated.

Output

The node outputs JSON data representing the result of the enable webhook operation. This typically includes confirmation details about the webhook status after enabling it. The exact structure depends on the SparkBot API response but generally confirms success or provides error information if enabling failed.

No binary data output is involved in this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
Needs network access to the SparkBot API endpoints.
Proper configuration of the webhook URL on the SparkBot platform is assumed.

Troubleshooting

Common issues:
- Providing an invalid or non-existent Webhook ID will cause the operation to fail.
- Network connectivity problems can prevent successful API calls.
- Insufficient permissions or incorrect API key may lead to authorization errors.
Error messages:
- Errors returned from the SparkBot API will be passed through; typical messages might indicate "Webhook not found" or "Unauthorized".
- If the node is set to continue on failure, errors will appear in the output JSON under an error field.
Resolutions:
- Verify the Webhook ID is correct and corresponds to an existing webhook.
- Check API key validity and permissions.
- Ensure the SparkBot service is reachable from your environment.

Links and References

SparkBot WhatsApp API Documentation (example link, replace with actual)
n8n Webhook Node Concepts: https://docs.n8n.io/nodes/n8n-nodes-base.webhook/

SparkBotInstall