Evolution API

Interagir com a Evolution API v2
Join our community

Actions53

Overview

This node integrates with the Evolution API v2 to manage and interact with "Instância" (Instance) resources, among others. Specifically, for the "Buscar Instâncias" (Fetch Instances) operation under the "Instância" resource, it retrieves all existing instances from the Evolution platform.

Common scenarios where this node is beneficial include:

  • Retrieving a list of all configured or active instances in your Evolution environment.
  • Monitoring or auditing instances before performing further actions like connecting, restarting, or deleting.
  • Automating workflows that depend on instance data fetched dynamically.

Practical example:

  • You want to fetch all WhatsApp instances managed by Evolution to display their statuses or perform batch operations such as reconnecting or restarting them.

Properties

Name Meaning
Instance Name The name identifier of the instance to operate on. Required for most instance-related operations but not specifically for fetching all instances.

Note: For the "Buscar Instâncias" operation, no additional input properties are required beyond selecting the resource and operation.

Output

The output JSON structure varies depending on the response from the Evolution API:

  • When fetching instances, the node returns an array of instance objects representing each instance's details.
  • Each item in the output array corresponds to one instance, containing its properties as provided by the API.
  • Additionally, the output includes metadata fields:
    • success: Boolean indicating if the operation was successful.
    • count: Number of instances returned.
    • timestamp: ISO string timestamp of when the operation completed.

No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "id": "instance1",
    "name": "MyInstance",
    "status": "connected",
    "success": true,
    "count": 3,
    "timestamp": "2024-06-01T12:00:00.000Z"
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating requests to the Evolution API.
  • The node uses HTTP methods (GET, POST, PUT, DELETE) to communicate with the Evolution API endpoints.
  • Proper configuration of the API authentication credential within n8n is necessary.
  • Network access to the Evolution API endpoint must be available.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Network connectivity problems preventing access to the Evolution API.
    • Incorrect instance names or parameters causing 404 or 400 errors.

  • Error messages:

    • Errors thrown by the node typically contain the message from the API response.
    • If the API returns an error, it will be surfaced in the node output unless "Continue On Fail" is enabled.

  • Resolutions:

    • Verify that the API key credential is correctly set up and has sufficient permissions.
    • Check network connectivity and firewall settings.
    • Ensure that instance names used in other operations exist and are spelled correctly.
    • Enable "Continue On Fail" in the node settings to handle partial failures gracefully.

Links and References

Discussion