Evolution API

Interagir com a Evolution API v2

Overview

This node integrates with the Evolution API v2, enabling automation and management of various messaging and communication-related resources such as instances, messages, groups, chats, events, and integrations. Specifically, for the Integração (Integration) resource with the Dify operation, it configures the Dify integration for a specified instance.

Common scenarios where this node is beneficial include:

  • Automating the setup of chatbot or customer support integrations.
  • Managing messaging workflows by connecting to external services like Dify.
  • Streamlining communication channels within a business environment.

For example, a user can configure the Dify integration on a particular instance to enable AI-powered chat responses or automate customer interactions through the Dify platform.

Properties

Name Meaning
Instance Name The name of the instance to configure the Dify integration on. This is required to identify which instance the integration applies to.

Output

The node outputs a JSON object representing the result of the integration configuration request. The output includes:

  • The response data from the Evolution API regarding the integration setup.
  • A success boolean indicating if the operation was successful.
  • A timestamp marking when the operation completed.

If the API returns no data, the node outputs a default success message with a timestamp.

No binary data output is indicated for this operation.

Example output structure:

{
  "success": true,
  "timestamp": "2024-06-01T12:00:00.000Z",
  // ...additional fields returned by the API
}

Dependencies

  • Requires an API key credential for authenticating requests to the Evolution API.
  • The node uses the Evolution API v2 endpoints to perform operations.
  • Proper configuration of the Evolution API credentials in n8n is necessary.
  • Network access to the Evolution API service must be available.

Troubleshooting

  • Common issues:

    • Incorrect or missing instance name will cause the API call to fail.
    • Invalid or expired API authentication token may lead to authorization errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Errors thrown by the node typically contain the API error message.
    • If the node fails due to invalid parameters, verify that all required fields are correctly set.
    • To handle errors gracefully, enable the "Continue On Fail" option in the node settings.
  • Resolution tips:

    • Double-check the instance name spelling and existence.
    • Ensure the API key credential is valid and has appropriate permissions.
    • Confirm that the Evolution API endpoint is reachable from your environment.

Links and References

Discussion