Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The "Create Instance" operation of the "Instance" resource in this node allows users to create and configure a new instance within the Evolution API platform. This instance represents a WhatsApp connection that can be customized with various behaviors, integrations, and network settings.

Typical use cases include:

  • Automating WhatsApp messaging workflows by programmatically creating instances linked to specific WhatsApp numbers.
  • Integrating WhatsApp communication with external platforms like Chatwoot for customer support.
  • Configuring proxy or message queue settings to fit enterprise networking or event handling requirements.

For example, a user might create an instance named "SupportBot" connected to a WhatsApp number, enabling automatic message reading and integrating it with Chatwoot to manage customer conversations seamlessly.

Properties

Name Meaning
Instance Name The name assigned to the new instance. This is required to identify the instance.
Apikey For Instance Optional token used for authenticating or securing the instance.
WhatsApp Number Optional phone number to connect with the instance, used to receive pairing codes and link the WhatsApp account.
Options A collection of optional configuration fields subdivided into:
- Behavior Settings controlling instance behavior such as:
• Reject Calls: Automatically reject incoming calls (true/false).
• Message on Reject: Text message sent after rejecting a call.
• Ignore Groups: Whether to ignore messages from group chats.
• Always Online: Keep the WhatsApp status always set to online.
• Read Messages: Automatically mark incoming messages as read.
• Read Status: Allow the API to view contact status updates.
• Sync Full History: Synchronize full message history with the API.
- Chatwoot Settings for integrating with Chatwoot customer engagement platform, including:
• Account ID, Admin Token, URL for Chatwoot instance.
• Agent signature toggle, conversation reopening, pending status options.
• Import contacts and messages, with control over import duration and merging Brazilian contacts.
• Custom inbox name, QR code contact name, and contact logo URL.
- Proxy Proxy server configuration including host, port, protocol (HTTP/HTTPS), username, and password.
- RabbitMQ Settings to enable RabbitMQ event monitoring and media data format (base64), with selection of events to monitor such as calls, chats, messages, presence updates, etc.
- Webhook Webhook configuration specifying the URL to receive events, whether to create separate routes per event, send media as base64, and select which events trigger webhooks (similar event list as RabbitMQ).

Output

The node outputs a JSON array containing the response from the Evolution API after creating the instance. This typically includes details about the newly created instance such as its identifier, status, and configuration summary.

If the instance creation involves media or event streaming, binary data output is not indicated here; the node focuses on JSON responses describing the instance setup.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • Network access to the Evolution API endpoint (https://doc.evolution-api.com/api-reference).
  • Optional dependencies based on configuration:
    • Chatwoot integration requires valid Chatwoot account credentials and URL.
    • Proxy settings require correct proxy server details if used.
    • RabbitMQ event monitoring requires access to a RabbitMQ server.
    • Webhook functionality requires a reachable webhook URL endpoint.

Troubleshooting

  • Unsupported operation error: If the selected operation or resource is not supported, the node throws an error indicating the function is unsupported. Ensure the correct resource and operation names are selected.
  • Authentication failures: Missing or invalid API tokens will cause authentication errors. Verify the API key/token is correctly provided.
  • Network issues: Proxy misconfiguration or unreachable endpoints may cause request failures. Check proxy settings and network connectivity.
  • Invalid input values: Required fields like "Instance Name" must be provided; missing these will result in validation errors.
  • Webhook or RabbitMQ event misconfiguration: Incorrect URLs or event selections may prevent proper event handling. Confirm all event names and URLs are valid.

Links and References

Discussion