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 can be customized with various behavioral settings, integration options (such as Chatwoot), proxy configurations, RabbitMQ event monitoring, and webhook setups.

This node is beneficial for automating the setup and management of instances that interact with messaging platforms or APIs, especially when integrating WhatsApp numbers or managing communication workflows. For example, it can be used to programmatically create an instance linked to a WhatsApp number, configure automatic message reading, reject calls with custom messages, and set up event-driven webhooks or message queues for real-time processing.

Properties

Name Meaning
Instance Name The name assigned to the new instance. This is a required string input.
Instance API Key An optional token for authenticating the instance. Used if the instance requires an API key for access.
WhatsApp Number Optional phone number to connect to the instance, which will receive the pairing code for WhatsApp integration.
Options A collection of additional configuration fields divided into subcategories:
- Behavior Settings controlling instance behavior:
-- Reject Calls Boolean to automatically reject incoming calls.
-- Message on Reject String message sent after rejecting a call.
-- Ignore Groups Boolean to ignore messages from group chats.
-- Always Online Boolean to keep the instance status always set to online.
-- Read Messages Boolean to automatically mark messages as read.
-- Read Status Boolean to allow the API to view the status updates of added contacts.
-- Sync History Boolean to synchronize the full message history with the API.
- Chatwoot Settings for integrating with Chatwoot customer engagement platform:
-- Chatwoot Account ID String ID of the Chatwoot account.
-- Chatwoot Admin Token Admin token for Chatwoot authentication.
-- Chatwoot URL URL of the Chatwoot instance.
-- Chatwoot Agent Signature Boolean to enable/disable agent signature in Chatwoot messages.
-- Reopen Messages in Chatwoot Boolean to enable reopening conversations upon receiving messages.
-- Start Conversations as Pending Boolean to start new conversations as pending.
-- Import Contacts to Chatwoot Boolean to import contacts into Chatwoot.
-- Chatwoot Inbox Name Name of the inbox in Chatwoot where messages will be routed.
-- Merge Brazilian Contacts Boolean to merge Brazilian contacts in Chatwoot.
-- Import Messages to Chatwoot Boolean to import historical messages into Chatwoot.
-- Days Limit for Message Import Number specifying how many days of messages to import into Chatwoot.
-- QR Code Contact Name in Chatwoot Name used for the QR code contact in Chatwoot.
-- Logo URL for Contact in Chatwoot URL of the logo image for the contact in Chatwoot. Default provided.
- Proxy Proxy server settings for routing requests:
-- Proxy Host Hostname or IP address of the proxy server.
-- Proxy Port Port number of the proxy server. Default is 1234.
-- Proxy Protocol Protocol used by the proxy, either HTTP or HTTPS.
-- Proxy Username Username for proxy authentication.
-- Proxy Password Password for proxy authentication.
- RabbitMQ Settings related to RabbitMQ event monitoring:
-- Enable or Disable RabbitMQ Boolean to enable sending media data in base64 format via RabbitMQ.
-- Events List of events to monitor through RabbitMQ, such as CALL, CHATS_UPDATE, MESSAGES_SET, etc.
- Webhook Settings for webhook event notifications:
-- Webhook URL URL endpoint to receive webhook events.
-- Webhook By Events Boolean to create separate routes per event by appending event names to the base URL.
-- Base64 In Webhook Boolean to send media data in base64 format in webhook payloads.
-- Events List of events to monitor and send via webhook, similar to RabbitMQ events.

Output

The node outputs a JSON array containing the response from the Evolution API after creating the instance. The structure typically includes details about the newly created instance such as its ID, status, configuration, and any relevant metadata returned by the API.

If the instance creation involves media or binary data (e.g., QR codes or attachments), those would be included in the output as well, but based on the properties, the main output is JSON data describing the instance.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API key credential or token for authentication if applicable.
  • Optional integration with Chatwoot requires valid Chatwoot account credentials and URLs.
  • If using RabbitMQ or webhooks, appropriate endpoints and services must be configured and accessible.
  • Proxy settings require a reachable proxy server if specified.

Troubleshooting

  • Missing Required Fields: Ensure that the "Instance Name" is provided; it is mandatory.
  • Authentication Errors: Verify that the API key/token is correct and has sufficient permissions.
  • Webhook or RabbitMQ Failures: Confirm that the URLs and event subscriptions are correctly configured and that the target services are reachable.
  • Proxy Connection Issues: Check proxy host, port, protocol, and credentials if connections fail.
  • Chatwoot Integration Problems: Validate all Chatwoot-related inputs, including account ID, admin token, and URLs.
  • Unsupported Operation Error: If the node throws an error about unsupported operations, verify that the selected resource and operation match "instances-api" and "instance-basic" respectively.

Links and References

Discussion