Wuzapi Trigger icon

Wuzapi Trigger

Receive WhatsApp events from Wuzapi with complete event mapping

Overview

This node acts as a trigger to receive WhatsApp events from the Wuzapi service. It listens for various types of WhatsApp-related events such as messages, calls, presence updates, reactions, read receipts, and more. The node processes incoming webhook data from Wuzapi, applies user-defined filters, optionally simplifies and parses the event data, and outputs structured information for use in workflows.

Common scenarios where this node is beneficial include:

  • Automating responses or actions based on incoming WhatsApp messages.
  • Monitoring user presence or typing indicators in chats.
  • Tracking message reactions or read receipts for analytics.
  • Handling interactive message responses or order events in WhatsApp Business integrations.
  • Filtering specific message types or senders to trigger targeted workflows.

Practical example: A business could use this node to listen for new customer messages containing certain keywords, then automatically route those messages to appropriate support agents or CRM systems.

Properties

Name Meaning
Events Select which WhatsApp event types to listen for. Options include: All Events, Call, Chat Presence, History Sync, Interaction, Message, Order, Presence, Reaction, Read Receipt.
Filters Collection of filters to narrow down processed events:
- From Phone (Sender): Only process messages from this phone number (full JID format).
- Chat ID: Only process messages from this chat.
- Message Type: Filter by content type (e.g., text, media, audio, document, sticker, location, buttons, list, template, poll, order).
- Contains Text: Only process messages containing specified text (case insensitive).
- Is Group: Filter by message source (any, groups only, direct only).
- Is From Me: Filter by sender (any, from me only, from others only).
- Token Filter: Only process events matching this token string.
Options Additional options to control output and processing:
- Include Raw Data: Include complete raw webhook data for debugging.
- Simplify Output: Simplify 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 Events selection.

Output

The node outputs JSON data representing the received WhatsApp event, filtered and optionally simplified according to the node settings.

When simplification is enabled, the output includes fields such as:

  • eventType: The type of event (e.g., "Message", "Call").
  • token: Event token identifier.
  • timestamp: ISO timestamp of event processing.
  • For message events: messageId, chat, sender, timestamp, messageType, mediaType, isFromMe, isGroup, pushName, verifiedName (if available), plus parsed message content fields like text, caption, imageUrl, videoUrl, audioUrl, locationName, etc.
  • For other event types (ReadReceipt, ChatPresence, Presence, Order, Interaction, Reaction, Call), relevant event-specific fields are included.
  • If raw data inclusion is enabled, the full original webhook payload is available under _rawWebhookData.

If media data inclusion is enabled, base64 encoded media and related metadata (mime type, file name, S3 data) are included when applicable.

Binary data output is empty (binary: {}) since this node does not produce binary attachments directly.

Dependencies

  • Requires an API key credential for authenticating with the Wuzapi WhatsApp service.
  • Must be configured with a webhook URL endpoint accessible by Wuzapi to receive event POST requests.
  • No additional external dependencies beyond standard n8n environment and the Wuzapi API.

Troubleshooting

  • No events triggering: Ensure that the webhook URL is correctly set up in Wuzapi and reachable by their servers. Verify that the selected event types and filters match the incoming events.
  • Filtered out events: If no workflow data is returned, check filter settings such as phone numbers, chat IDs, message types, and tokens to confirm they align with actual event data.
  • Missing media data: Confirm that "Include Media Data" option is enabled if expecting base64 or S3 media content in output.
  • Unknown event types ignored: Enable "Allow Unknown Events" option to process event types not explicitly listed.
  • Authentication errors: Make sure the API key credential is valid and properly configured.
  • Parsing issues: Disable "Parse Message Content" if message content extraction causes problems or if raw data inspection is preferred.

Links and References

Discussion