Green API Trigger

Enhanced WhatsApp trigger with file support and advanced filtering

Overview

This node acts as a trigger for Green API WhatsApp events, enabling workflows to respond to various WhatsApp activities such as incoming messages, session status changes, group updates, and more. It supports advanced filtering options including event types, chat and sender filters, message content filters, and file type downloads. This node is useful for automating responses, monitoring WhatsApp interactions, and integrating WhatsApp data into broader automation workflows.

Use Case Examples

  1. Automatically respond to incoming WhatsApp messages containing specific keywords.
  2. Download and process media files (images, audio, documents) received via WhatsApp.
  3. Filter and trigger workflows only for messages from specific chats or senders.
  4. Track group membership changes and react accordingly.

Properties

Name Meaning
Events Select which Green API WhatsApp events to listen for, such as messages, session status changes, group updates, and more.
Download Files Automatically download received files such as images, audio, and documents.
File Types Specify which file types to download when 'Download Files' is enabled.
Chat Filter Filter events to only those from a specific chat ID.
Sender Filter Filter events to only those from a specific sender ID.
Advanced Options Additional filtering and processing options including instance ID filter, inclusion of quoted messages, parsing mentions, including raw data, and file download timeout.
Filters Message content and type filters including keyword filtering, message type filtering, chat type filtering, exclusion of bot or forwarded messages, and message length constraints.

Output

JSON

  • event - Type of the triggered event (e.g., message, session status change).
  • timestamp - ISO timestamp when the event was processed.
  • instanceId - ID of the Green API instance that generated the event.
  • messageData
    • messageId - ID of the message involved in the event.
    • chatId - Chat ID where the message was sent or received.
    • senderId - ID of the sender of the message.
    • senderName - Name of the sender.
    • textMessage - Text content of the message.
    • timestamp - Timestamp of the message.
    • type - Type of the message (e.g., textMessage, imageMessage).
    • isGroup - Boolean indicating if the message is from a group chat.
    • quotedMessage
      * messageId - ID of the quoted or replied message, if included.
      * text - Text of the quoted or replied message.
      * type - Type of the quoted message.
    • mentions - Array of parsed @mentions in the message text, if enabled.
  • hasFile - Boolean indicating if the message contains a downloadable file.
  • instance
    • id - ID of the Green API instance.
    • webhookUrl - Webhook URL configured for the instance.
    • senderData - Additional sender data from the instance.
  • rawData - Raw webhook data received from Green API, included if enabled.
  • error - Error message if an error occurred during processing.

Dependencies

  • Green API service with API key credentials

Troubleshooting

  • Invalid webhook data error: Occurs if the incoming webhook payload lacks the required 'typeWebhook' property. Ensure the webhook is correctly configured and the payload is valid.
  • No workflow trigger: If the event type or filters do not match the configured settings, the workflow will not trigger. Verify event selections and filter criteria.
  • File download issues: If file downloads are enabled but fail, check network connectivity, file type settings, and timeout configuration.
  • Filtering too restrictive: Overly restrictive filters (e.g., chat ID, sender ID, keywords) may prevent any events from triggering the workflow. Adjust filters as needed.

Links

Discussion