ZuckZapGo Trigger icon

ZuckZapGo Trigger

Receive WhatsApp events from ZuckZapGo with complete event mapping
Join our community

Overview

This node, named "ZuckZapGo Trigger," is designed to receive and process WhatsApp events from the ZuckZapGo service. It acts as a webhook trigger that listens for various WhatsApp-related event types such as incoming messages, call events, group updates, presence changes, and more. The node filters and processes these events, optionally simplifying and parsing message content for easier consumption in workflows.

Common scenarios where this node is beneficial include:

  • Automating responses or actions based on specific WhatsApp messages or events.
  • Monitoring WhatsApp group activities or user presence.
  • Integrating WhatsApp messaging with other systems like CRMs, helpdesks, or marketing platforms.
  • Handling media messages and extracting relevant content automatically.

Practical example:

  • A business wants to automate customer support by triggering workflows when new WhatsApp messages arrive from customers, filtering only text messages containing certain keywords, and then routing them to appropriate agents or systems.

Properties

Name Meaning
Events Select which WhatsApp event types to listen for. Options include all standard WhatsApp events such as Message, Call Offer, Group Info, Presence, Read Receipt, and many others. Selecting "All" subscribes to every event type.
Filters Collection of filters to narrow down processed events:
- From Phone (Sender): Only process messages from a specific phone number (full JID format).
- Chat ID: Only process messages from a specific chat/group.
- Message Type: Filter by message content type (e.g., text, image, video, sticker, location, etc.).
- Contains Text: Only process messages containing specified text (case insensitive).
- Is Group: Filter messages by source (any, groups only, direct only).
- Is From Me: Filter messages by sender (any, from me only, from others only).
- Token Filter: Only process events matching a specific token string.
Options Additional options to control output and processing:
- Include Raw Data: Include complete raw webhook data for debugging.
- Simplify Output: Simplify the output structure for easier use.
- Include Media Data: Include base64 and S3 media data in output.
- Parse Message Content: Extract and parse message content from complex message types.
- Allow Unknown Events: Process unknown event types not listed in the Events selection, useful for future or custom event types.

Output

The node outputs JSON data representing the received WhatsApp event, structured according to the selected options and filters:

  • eventType: The type of event received (e.g., Message, CallOffer, Presence).
  • token: Event token identifier.
  • timestamp: ISO timestamp of the event processing time.
  • For Message events, includes detailed fields such as:
    • messageId, chat, sender, timestamp, messageType, mediaType.
    • Flags like isFromMe, isGroup, pushName, verifiedName.
    • Parsed message content fields depending on message type (text, ads, url, audio, image, video, document, sticker, location, contact, buttons, list, template, interactive, poll, event, product, order).
    • Media data if enabled (base64, mimeType, fileName, S3 data).
  • For other event types, relevant fields are included, e.g., conversion data for Facebook Ads conversions, read receipt details, presence info, order status, call data, etc.
  • If an unknown event type is received and allowed, the node outputs the raw event data along with debug information.
  • If "Include Raw Data" option is enabled, the full original webhook payload is included under _rawWebhookData.
  • Binary output is empty (binary:{}) as this node does not produce binary data directly.

Dependencies

  • Requires receiving webhook POST requests from the ZuckZapGo WhatsApp integration service.
  • Optionally uses an API key credential for ZuckZapGo API access (not mandatory).
  • No additional external dependencies are required.
  • The node expects proper configuration of the webhook URL in ZuckZapGo to forward events to n8n.

Troubleshooting

  • No events received: Ensure the webhook URL is correctly configured in ZuckZapGo and that the node is active.
  • Events filtered out unexpectedly: Check filter settings carefully; filters like From Phone, Chat ID, Message Type, and Contains Text can exclude events.
  • Unknown event types ignored: Enable "Allow Unknown Events" option to process new or custom event types.
  • Parsing errors on ads conversion data: The node attempts to parse conversion data JSON; malformed data may cause parsing failures but will fallback to raw data.
  • Media data missing: Verify "Include Media Data" option is enabled to receive base64 or S3 media content.
  • Token filter blocking events: Confirm the token filter matches the token sent by ZuckZapGo if used.
  • Simplified output missing fields: Disable "Simplify Output" to get full raw event structure for debugging.

Links and References

Discussion