Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

The node integrates with the Evolution API to manage WhatsApp automation tasks. Specifically, for the Webhook - Get Webhook operation, it retrieves the current webhook configuration of a WhatsApp instance managed by the Evolution API.

This node is useful when you want to programmatically check which webhook URL and event subscriptions are currently set up for your WhatsApp instance. For example, you might use this to verify webhook settings before updating them or to audit your integration setup.

Practical scenarios include:

  • Monitoring webhook configurations in automated workflows.
  • Debugging webhook-related issues by fetching current webhook details.
  • Integrating webhook status checks into larger automation pipelines.

Properties

Name Meaning
Additional Fields Collection of optional fields that can modify message sending behavior (not used in this operation). Options include:
• Delay: Delay in milliseconds before sending.
• Link Preview: Enable/disable link preview in messages.
• Quoted Message ID: ID of message to quote/reply to.
• Mentions: Comma-separated list of numbers to mention.

Note: For the Get Webhook operation, only the resource and operation parameters are relevant; the "Additional Fields" property is defined but not utilized.

Output

The output JSON contains the webhook configuration details retrieved from the Evolution API for the specified WhatsApp instance. This typically includes:

  • The webhook URL currently set.
  • Whether the webhook is enabled.
  • The list of subscribed events (e.g., application startup, QR code updates, message updates, presence updates, contact updates, group updates).

Example output structure (simplified):

{
  "url": "https://your-webhook-url.com",
  "enabled": true,
  "events": [
    "APPLICATION_STARTUP",
    "QRCODE_UPDATED",
    "CONNECTION_UPDATE",
    "MESSAGES_UPSERT",
    "MESSAGES_UPDATE",
    "PRESENCE_UPDATE",
    "CHATS_UPSERT",
    "CONTACTS_UPDATE",
    "GROUPS_UPSERT"
  ]
}

No binary data is involved in this operation.

Dependencies

  • Requires an active connection to the Evolution API with valid credentials including:

    • Base URL of the Evolution API.
    • API key for authentication.
    • Instance name identifying the WhatsApp instance.

  • Also requires credentials for an auxiliary API ("N8N Tools API") used for subscription validation before making requests.

  • The node expects these credentials to be configured in n8n prior to execution.

Troubleshooting

  • Invalid Subscription or API Key Error:
    If the node throws an error indicating invalid subscription or API key, verify that both the Evolution API and the auxiliary API credentials are correctly set and have appropriate permissions.

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

  • Network or Request Failures:
    Check network connectivity and that the Evolution API base URL is reachable. Also confirm the instance name is correct.

  • Empty or Unexpected Response:
    If the webhook configuration response is empty or missing expected fields, verify that a webhook has been set previously on the instance.

Links and References

Discussion