Evolution API

Complete WhatsApp automation with Evolution API

Actions48

Instance → Restart Instance

AI-generated

Overview

This node integrates with the Evolution API to manage WhatsApp instances and perform various operations related to WhatsApp automation. Specifically, for the Instance resource and the Restart Instance operation, it allows users to restart a WhatsApp instance programmatically. This can be useful in scenarios where the WhatsApp connection needs to be refreshed or reset without manual intervention.

Practical examples include:

Automatically restarting an instance after detecting connectivity issues.
Scheduling periodic restarts to maintain optimal performance.
Restarting an instance as part of a larger workflow that manages WhatsApp sessions dynamically.

Properties

Name	Meaning
Additional Fields	Optional extra parameters to customize the request. Includes:
- Delay	Delay in milliseconds before sending the request.
- Link Preview	Enable or disable link preview in messages (true/false).
- Quoted Message ID	ID of a message to quote or reply to (string).
- Mentions	Comma-separated list of phone numbers to mention in the message (string).

Note: For the Restart Instance operation specifically, these additional fields are available but may not affect the restart action directly since the operation does not require message-specific parameters.

Output

The node outputs JSON data representing the response from the Evolution API after attempting to restart the instance. The structure typically includes status information about the restart request, such as success confirmation or error details.

Example output JSON structure (simplified):

{
  "status": "success",
  "message": "Instance restarted successfully",
  "instanceName": "your-instance-name"
}

If an error occurs, the output will contain an error field describing the issue.

The node does not output binary data.

Dependencies

Requires an active subscription and valid API keys for:
- The Evolution API service (for WhatsApp instance management).
- An auxiliary API service used for validation (referred to generically as a tools API).
Credentials must be configured in n8n for both services, including:
- Base URL and API key for the Evolution API.
- API URL and API key for the validation service.
The node uses HTTP requests to communicate with these APIs.

Troubleshooting

Invalid Subscription or API Key:
Error message: "N8N Tools API: Invalid subscription or API key. Please check your credentials."
Resolution: Verify that the API keys and subscriptions for both the Evolution API and the validation service are correct and active.
Unknown Operation or Resource Errors:
If the node is configured with an unsupported operation or resource, it throws errors like "Unknown instance operation: restartInstance".
Resolution: Ensure the selected resource is "Instance" and the operation is "Restart Instance".
Network or API Errors:
General HTTP errors during API calls will be reported. Check network connectivity and API endpoint availability.
Continue on Fail Behavior:
If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Evolution API Documentation (general WhatsApp automation):
(No direct link provided in source; refer to your Evolution API provider's official docs)
n8n Documentation on Custom Nodes and Credentials:
https://docs.n8n.io/
WhatsApp Business API Concepts (for context on instances and connections):
https://developers.facebook.com/docs/whatsapp/api

This summary focuses on the Instance resource and the Restart Instance operation as requested.

Evolution APIInstall