Evolution API NKInstall

Summary

Create a new instance with a specified name and optional configurations such as API key, WhatsApp number, Chatwoot integration settings, instance behavior options, proxy settings, RabbitMQ events monitoring, and webhook configurations.

Inputs

• Nome Da Instância (required) — Specify the name for the new instance.
• Apikey Para Instancia — Optionally provide an API key token for the instance.
• Número Do WhatsApp — Optionally specify the WhatsApp number to connect with the instance for receiving pairing codes.
• Opções — Configure optional detailed settings including Chatwoot integration (account ID, token, URL, signature, message reopening, contact/message import options, inbox name, contact merging), instance behavior (call rejection, message on reject, group message ignoring, always online status, auto-read messages and status, full history sync), proxy server settings (host, port, protocol, user, password), RabbitMQ event monitoring (enablement and events list), and webhook setups (URL, per-event routing, base64 media, events to monitor).

Output shape

a single record

Returns the created instance details as a JSON object with the supplied parameters and server response.

Examples

Example 1: Create an instance named "TestInstance" with call rejection enabled and Chatwoot integration configured.

Set 'Nome Da Instância' to 'TestInstance'; under 'Opções', enable 'Comportamento' > 'Rejeitar Ligações' as true, and fill Chatwoot account ID, token, and URL.