Actions2
- Instance Actions
- Send Message Actions
Overview
This node allows users to create an instance in the Evolution Go platform. It is useful for automating the setup of new instances with specific configurations such as proxy settings, webhook URLs, and instance behavior settings like always being online or rejecting calls. For example, a user can create an instance named 'MyInstance' with a proxy and webhook configured to receive message events.
Use Case Examples
- Create a new instance named 'MyInstance' with a specified token and proxy settings.
- Set up an instance that always stays online and rejects incoming calls with a custom rejection message.
- Configure a webhook URL to receive specific events like MESSAGE and CALL for the created instance.
Properties
| Name | Meaning |
|---|---|
| Instance Name | The name of the instance to create, required for identification. |
| Token | Optional token for the instance, used for authentication or identification. |
| Options | Additional configuration options for the instance including proxy settings, instance behavior settings, and webhook configuration. |
| Advanced Settings | Hidden property that consolidates instance behavior settings into a structured object for the API request. |
| Proxy | Hidden property that consolidates proxy settings into a structured object for the API request. |
| Webhook | Hidden property for the webhook URL to receive events. |
| Webhook Events | Hidden property listing the webhook events to receive. |
| Request Options | Node-level request options such as batching, SSL certificate validation, proxy, and timeout settings. |
Output
JSON
id- The unique identifier of the created instance.name- The name of the created instance.token- The token associated with the created instance, if provided.proxy- Proxy settings applied to the instance, if any.settingsalwaysOnline- Boolean indicating if the instance is set to always be online.rejectCall- Boolean indicating if the instance rejects incoming calls.msgRejectCall- Message sent when rejecting calls, if configured.
webhook- The webhook URL configured for the instance.webhookEvents- List of webhook events the instance is subscribed to.
Dependencies
- An API key credential for authenticating with the Evolution Go API
Troubleshooting
- Ensure the 'Instance Name' is provided as it is required; missing this will cause the request to fail.
- If proxy settings are incorrect or incomplete, the instance creation may fail or the instance may not connect properly.
- Webhook URLs must be valid and accessible; otherwise, webhook events will not be received.
- If SSL certificate validation is disabled, be aware of potential security risks.
- Timeout settings should be adjusted based on network conditions to avoid premature request failures.