SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node enables sending and managing WhatsApp messages through the SparkBot WhatsApp API. Specifically, the Send meeting confirmation operation allows users to respond to event invitations by accepting or declining them. This is useful in scenarios where automated workflows need to confirm attendance for meetings or events via WhatsApp, such as appointment reminders, event RSVPs, or calendar invites.

Practical examples include:

  • Automatically confirming a scheduled meeting with a client after booking.
  • Declining an event invitation based on business logic or availability.
  • Integrating WhatsApp event confirmations into CRM or scheduling systems.

Properties

Name Meaning
WhatsApp number The SparkBot Number ID used to send the message. This identifies the WhatsApp number/account from which the confirmation will be sent.
Event Message ID The unique identifier of the event message to which you are responding. Must be a hexadecimal string between 18 and 32 characters.
Response Your reply to the event invitation. Options: "Accept Invitation" or "Decline Invitation".
Options Additional optional settings for message delivery and post-delivery actions:
- Priority (Normal, High, Low)
- Label (custom categorization label)
- Reference ID (custom reference)
- Team Agent (send on behalf of an agent)
- Live mode (real-time sending without queue)
- Delivery Queue Mode (default, always queue, never queue, opportunistic)
- Maximum Retries
- Chat Actions (assign, resolve, label, metadata, etc.)
Message Expiration Defines how long the message remains valid before expiring. Can specify expiration in seconds, duration format (e.g., "1h"), or a specific date/time.
Mark Chat as Read Whether to notify WhatsApp that previous unread messages in the chat have been read (blue double-check).
Typing simulation Number of seconds to simulate typing or recording status before sending the message (0 disables this). Useful for more natural interaction.
Quote Message Optionally quote another message in the same conversation by specifying its message ID (hexadecimal string 18-32 chars).
Strict Message Order Ensures messages are sent in strict order to the target chat. Useful for chatbots or sequences but incompatible with live mode or never queue delivery options.

Output

The node outputs JSON data representing the result of the confirmation message operation. This typically includes details about the sent message, such as message IDs, status, and any relevant metadata returned by the SparkBot API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on the SparkBot service being accessible and properly configured.
  • Some properties load dynamic options (e.g., devices, groups, labels, agents) via internal methods, so proper API access and permissions are necessary.
  • No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

  • Invalid Event Message ID: If the event message ID does not match the required hexadecimal length (18-32 chars), the node will throw a validation error. Ensure the ID is correct and formatted properly.
  • Missing Required Fields: Omitting required fields like WhatsApp number, event message ID, or response will cause errors. Double-check all mandatory inputs.
  • API Authentication Errors: If the API key is invalid or missing, the node will fail to authenticate. Verify the API key credential configuration.
  • Delivery Failures: Using real-time delivery modes ("live" or "never queue") at high message volumes may increase the risk of WhatsApp bans or message failures. Use queue modes appropriately.
  • Typing Simulation Limits: Typing simulation must be between 2 and 30 seconds if enabled; otherwise, set to 0 to disable.
  • Strict Order Conflicts: Enabling strict message order is incompatible with live mode or never queue delivery options and will cause errors if combined.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions. It does not execute or infer runtime behavior beyond what is statically declared.

Discussion