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 contacts and perform various contact-related operations. Specifically, the "Get Contacts" operation retrieves all contacts associated with a WhatsApp instance.

Common scenarios where this node is beneficial include:

  • Synchronizing WhatsApp contacts with other systems or CRMs.
  • Automating workflows that require access to a user's WhatsApp contact list.
  • Monitoring or analyzing contact data for marketing or support purposes.

For example, you could use this node to fetch all contacts from a WhatsApp instance and then filter or process them in subsequent workflow steps.

Properties

Name Meaning
Additional Fields Optional extra parameters to customize the request:
- Delay: Delay in milliseconds before sending (number)
- Link Preview: Enable link preview in messages (boolean)
- Quoted Message ID: ID of message to quote/reply to (string)
- Mentions: Comma-separated list of numbers to mention (string)

Note: For the "Get Contacts" operation, no additional input properties like phone number are required.

Output

The output is an array of JSON objects representing the contacts retrieved from the WhatsApp instance. Each item corresponds to one contact's data as returned by the Evolution API.

The exact structure depends on the API response but typically includes contact identifiers, names, and possibly status information.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for the Evolution API to authenticate requests.
  • Optionally uses another API key credential for a validation service ("N8N Tools API") to verify subscription and API key validity before making calls.
  • The node expects configuration of the WhatsApp instance name and base URL via credentials.

Troubleshooting

  • Invalid Subscription or API Key: If the node throws an error about invalid subscription or API key, verify that the provided API keys for both the Evolution API and the validation service are correct and active.
  • Unknown Operation or Resource Errors: These indicate misconfiguration of the resource or operation parameters; ensure "Contact" is selected as the resource and "Get Contacts" as the operation.
  • Network or Timeout Issues: Ensure the Evolution API base URL is reachable and the network connection is stable.
  • Empty Contact List: This might mean no contacts exist in the WhatsApp instance or there is an issue with permissions.

Links and References

Discussion