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 instances and perform various WhatsApp-related operations. Specifically, the Get Instance operation under the Instance resource retrieves information about existing WhatsApp instances managed by the Evolution API.

Common scenarios for this node include:

  • Monitoring the status and details of WhatsApp instances used in automation workflows.
  • Retrieving instance metadata to verify connection or configuration before sending messages.
  • Automating instance management tasks as part of larger WhatsApp automation pipelines.

For example, a user might use this node to fetch all active WhatsApp instances and then decide which instance to use for sending messages based on their availability or other criteria.

Properties

Name Meaning
Additional Fields Optional extra parameters:
- Delay: Delay in milliseconds before sending.
- Link Preview: Enable or disable link preview in messages.
- Quoted Message ID: ID of a message to quote or reply to.
- Mentions: Comma-separated list of phone numbers to mention in the message.

Note: For the Get Instance operation, no additional input properties beyond "Additional Fields" are required or used.

Output

The output is an array of JSON objects representing the response from the Evolution API's endpoint that fetches WhatsApp instances. Each item corresponds to one input item processed and contains:

  • json: The JSON data returned by the API, typically including details about one or more WhatsApp instances such as instance IDs, names, statuses, and other metadata.

No binary data is produced by this operation.

Example output structure (simplified):

[
  {
    "json": {
      "instances": [
        {
          "id": "instance_1",
          "name": "My WhatsApp Instance",
          "status": "connected",
          "createdAt": "2024-01-01T12:00:00Z"
        },
        {
          "id": "instance_2",
          "name": "Backup Instance",
          "status": "disconnected",
          "createdAt": "2023-12-15T08:30:00Z"
        }
      ]
    }
  }
]

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 validate subscription and API key before making calls.
  • The node expects configuration of:
    • Base URL of the Evolution API.
    • API key for authentication.
    • Instance name identifier to target specific WhatsApp instances.

Troubleshooting

  • Invalid subscription or API key error: If the node throws an error indicating invalid subscription or API key, verify that the provided API keys are correct and have the necessary permissions.
  • Unknown operation or resource errors: These occur if unsupported operations or resources are selected. Ensure the Resource is set to "Instance" and Operation to "Get Instance".
  • Network or connectivity issues: Failures to reach the Evolution API endpoint may be due to network problems or incorrect base URLs.
  • Empty or unexpected responses: Confirm that there are active WhatsApp instances configured in the Evolution API backend.

Links and References

Discussion