Actions148
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
Overview
This node enables sending WhatsApp meeting event messages via the SparkBot WhatsApp API. It is designed to create and send calendar-like event invitations or notifications directly to WhatsApp users, groups, or channels. This functionality is useful for businesses or teams that want to notify participants about meetings, appointments, or events with detailed information such as event name, description, date/time, location, and call type (voice/video).
Practical examples:
- Sending a meeting invite to a client’s phone number with event details and a video call link.
- Notifying a WhatsApp group about an upcoming team meeting with location coordinates.
- Broadcasting an event announcement to a channel with optional descriptions and expiration settings.
Properties
| Name | Meaning |
|---|---|
| WhatsApp number | The SparkBot Number ID used to send the message. Select from available registered numbers. |
| Target | Type of target chat: Phone (individual), Group, or Channel. |
| Phone Number | Target individual phone number in international E.164 format (e.g., +1234567890). Required if Target is Phone. |
| Group ID | ID of the target WhatsApp group chat (e.g., 12345678902401234@g.us). Required if Target is Group. |
| Channel ID | ID of the target WhatsApp channel (e.g., 12345678902402200@newsletter). Required if Target is Channel. |
| Event Name | Title or name of the event (max 100 characters). |
| Event Description | Optional detailed description of the event (up to 2048 characters). |
| Event Date and Time | Date and time of the event in ISO 8601 format. |
| Event Location | Optional textual location name for the event (max 255 characters). |
| Location Coordinates | Optional geographical coordinates (latitude and longitude) for the event location. Latitude must be between -90 and 90; longitude between -180 and 180. |
| Meeting Call Type | Type of WhatsApp call associated with the event: No Call, Voice Call, or Video Call. |
| Options | Collection of additional message options including: - Priority (Normal, High, Low) - Label (custom categorization) - Reference ID - Team Agent (send on behalf of an agent) - Live mode (real-time delivery) - Delivery queue mode (default, always queue, never queue, opportunistic) - Maximum retries - Post-delivery chat actions (assign, resolve, label management, metadata management, etc.) |
| Message Expiration | Defines message TTL with options: - Expire after seconds - Expire after duration (e.g., 1h, 30m) - Expire at specific date/time |
| Mark Chat as Read | Boolean to notify WhatsApp that previous unread messages will be marked as read after delivery (blue double-check). |
| Typing simulation | Seconds to simulate typing or recording status before sending the message (2-30 seconds). Set 0 to disable. |
| Quote Message | Message ID to quote when sending this event message (must be 18-32 hex characters and in the same conversation). |
| Strict Message Order | Boolean to ensure messages are sent in strict order. Useful for chatbots or sequences. Not compatible with live mode or never queue delivery. |
Output
The node outputs JSON data representing the result of the send meeting event operation. This typically includes confirmation details such as message IDs, status, timestamps, and any relevant metadata returned by the SparkBot API.
If binary data were involved (not applicable here), it would represent media content or files attached to the message.
Dependencies
- Requires an API key credential for authenticating with the SparkBot WhatsApp API.
- The node depends on SparkBot's backend services to send WhatsApp messages.
- Some properties load dynamic options (e.g., devices, groups, channels, agents, labels) which require proper API access and permissions.
- Proper configuration of the SparkBot account and WhatsApp numbers is necessary.
Troubleshooting
- Invalid phone number format: Ensure phone numbers follow the E.164 international format (e.g., +1234567890). The node validates this with regex.
- Missing required fields: Event name, date/time, and target identifiers (phone/group/channel) are mandatory. Omitting these will cause errors.
- Delivery failures: Using real-time delivery mode ("live" or "never queue") for high-volume messaging can lead to WhatsApp bans or message drops. Use queue modes appropriately.
- Agent or department IDs invalid: When assigning chats post-delivery, agent and department IDs must be valid 24-character hexadecimal strings.
- Message quoting errors: Quoted message IDs must be valid and belong to the same conversation.
- Expiration misconfiguration: Ensure expiration times are within allowed ranges and correctly formatted.
- API authentication errors: Verify the API key credential is valid and has sufficient permissions.
- Typing simulation limits: Values outside 0-30 seconds may be rejected.
Links and References
- WhatsApp Business API Documentation
- E.164 Phone Number Formatting
- SparkBot official documentation (refer to your SparkBot provider resources for detailed API usage and limitations)