Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

This node integrates with the Evolution API to manage WhatsApp automation tasks. Specifically, the Webhook - Set Webhook operation allows users to configure a webhook URL that will receive various WhatsApp event notifications such as application startup, QR code updates, connection changes, message updates, presence updates, chat updates, contact updates, and group updates.

This is useful in scenarios where you want to automate workflows triggered by WhatsApp events, for example:

  • Automatically processing incoming messages.
  • Updating your system when connection status changes.
  • Reacting to group membership changes or contact updates.

By setting a webhook URL, you enable real-time event-driven automation between WhatsApp and your applications via n8n.

Properties

Name Meaning
Webhook URL The URL endpoint where WhatsApp event notifications will be sent.
Additional Fields Optional extra settings:
• Delay (ms) before sending
• Link Preview enabled (true/false)
• Quoted Message ID (to reply to a specific message)
• Mentions (comma-separated list of numbers to mention)

Output

The node outputs JSON data representing the response from the Evolution API after setting the webhook. This typically includes confirmation details about the webhook configuration.

The output structure is:

{
  "json": {
    // API response confirming webhook setup, e.g.:
    "url": "https://your-webhook-url",
    "enabled": true,
    "events": [
      "APPLICATION_STARTUP",
      "QRCODE_UPDATED",
      "CONNECTION_UPDATE",
      "MESSAGES_UPSERT",
      "MESSAGES_UPDATE",
      "PRESENCE_UPDATE",
      "CHATS_UPSERT",
      "CONTACTS_UPDATE",
      "GROUPS_UPSERT"
    ]
  },
  "pairedItem": {
    "item": 0
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an active subscription and valid API key credentials for the Evolution API service.
  • Requires configuration of the Evolution API base URL, API key, and instance name within n8n credentials.
  • Also depends on a secondary API validation call to a helper API service to verify subscription and API key validity before executing the main request.

Troubleshooting

  • Invalid subscription or API key error:
    If the node throws an error indicating invalid subscription or API key, verify that the provided API credentials are correct and active.

  • Unknown resource or operation errors:
    These occur if the resource or operation parameters are incorrect or unsupported. Ensure the Resource is set to "Webhook" and Operation to "Set Webhook".

  • Network or connectivity issues:
    Failures to reach the Evolution API endpoint may cause errors. Check network connectivity and that the base URL is correctly configured.

  • Webhook URL not reachable:
    The webhook URL must be publicly accessible to receive events. Test the URL externally to confirm it can accept POST requests.

  • Continue On Fail behavior:
    If enabled, the node will return error details in the output JSON instead of stopping execution on failure.

Links and References

Discussion