Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API to create and manage instances. Specifically, the 'Create Instance' operation allows users to set up a new instance with customizable settings such as instance behavior, Chatwoot integration, proxy configuration, RabbitMQ event monitoring, and webhook settings. This node is useful for automating the creation and configuration of instances in the Evolution API environment, enabling integration with messaging platforms and event handling systems.

Use Case Examples

  1. Create a new instance with a specified name and optional API key to automate WhatsApp messaging workflows.
  2. Configure instance behavior to reject calls automatically and send a custom message upon rejection.
  3. Integrate the instance with Chatwoot for customer support management, including importing contacts and messages.
  4. Set up proxy settings for network routing and enable RabbitMQ to monitor specific events for real-time processing.

Properties

Name Meaning
Instance Name The name assigned to the new instance, required for identification.
API Key For Instance Optional token used for authenticating the instance with the API.
WhatsApp Number Optional phone number connected to the instance to receive pairing codes.
Options Additional configuration options including instance behavior, Chatwoot integration, proxy settings, RabbitMQ event monitoring, and webhook settings.

Output

JSON

  • instanceId - The unique identifier of the created instance.
  • instanceName - The name of the created instance.
  • status - The status of the instance creation process.
  • details - Additional details or metadata returned from the API about the created instance.

Dependencies

  • Requires an API key credential for authentication with the Evolution API.

Troubleshooting

  • Ensure the 'Instance Name' is provided as it is required; missing this will cause errors.
  • Verify the API key if provided is correct and has necessary permissions to create instances.
  • Check network connectivity and proxy settings if the instance creation fails due to connection issues.
  • Review the selected options for compatibility and correctness, especially when integrating with external services like Chatwoot or RabbitMQ.

Discussion