Actions114
- Instance Actions
- Message Actions
- Group Actions
- Chat Actions
- Profile Actions
- Event Actions
- Integration Actions
- Call Actions
- Label Actions
- OpenAI Actions
- N8N Integration Actions
- EvoAI Actions
- Template Actions
- Business Actions
Instance → Create Instance
AI-generatedOverview
This node creates a new instance in the Evolution API system. It is useful for users who want to programmatically set up and configure instances with specific behaviors, proxy settings, RabbitMQ integration, webhook configurations, and Chatwoot integration. For example, a user can create an instance with automatic call rejection, message reading, and synchronization of full message history, while also setting up webhook URLs to receive event notifications.
Use Case Examples
- Creating a WhatsApp instance with a specific phone number and API key, enabling automatic message reading and always online status.
- Setting up an instance with proxy settings and RabbitMQ event monitoring for advanced message handling.
- Configuring an instance to integrate with Chatwoot for customer support management, including importing contacts and messages.
Properties
| Name | Meaning |
|---|---|
| Instance Name | The name assigned to the instance being created, used to identify it. |
| Apikey For Instance | Optional API token used for authenticating the instance creation request. |
| WhatsApp Number | Optional phone number connected to the instance to receive the pairing code. |
| Options | Additional configuration options for the instance, including behavior settings, 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 operation, e.g., success or failure.pairingCode- The pairing code sent to the WhatsApp number if provided, used to link the instance.
Dependencies
- Evolution API service requiring an API key credential for authentication.
Troubleshooting
- Ensure the API key is valid and has the necessary permissions to create instances.
- Verify that the WhatsApp number is correctly formatted and able to receive pairing codes if provided.
- Check network connectivity and proxy settings if using a proxy to avoid connection failures.
- Review the event names and settings for RabbitMQ and webhook configurations to ensure they are valid and supported by the API.