Evolution API

Interact with Evolution API

Actions64

Overview

The Evento - Webhook operation in this custom n8n node allows you to manage webhooks for the Evolution API. It enables users to set up or verify webhook configurations for receiving real-time event notifications from an Evolution API instance. This is useful for integrating external systems with Evolution API, such as triggering workflows when specific events occur (e.g., new messages, group updates, contact changes).

Common scenarios:

Automatically process incoming WhatsApp messages by setting a webhook.
Monitor and react to group participant changes or message deletions.
Integrate Evolution API events with CRMs, support systems, or notification services.

Practical example:
A business wants to receive notifications in their CRM whenever a customer sends a WhatsApp message. By configuring the webhook via this node, the CRM can be updated in real time.

Properties

Below are the supported input properties for the Evento - Webhook operation:

Display Name	Type	Description
Nome Da Instancia	String	Digite o nome da instância que vai enviar a mensagem (Enter the name of the instance sending the message).
O Que Deseja Fazer	Options	Escolha entre definir um novo webhook ou verificar o webhook (Set or check the webhook).
Ativar Webhook	Boolean	Whether to enable or disable integration with Webhook. (Only for "Definir Webhook")
Url Do Webhook	String	Digite a URL que vai receber os eventos do Webhook (Webhook receiver URL). (Only for "Definir Webhook")
Webhook Por Eventos	Boolean	Whether to create a route for each event by appending the event name to the end of the URL.
Base64 No Webhook	Boolean	Whether to send media data in base64 format in the webhook.
Eventos	MultiOptions	Select which events will trigger the webhook. Options include CALL, CHATS_DELETE, MESSAGES_UPSERT, etc.

Note: Some fields only appear when "O Que Deseja Fazer" is set to "Definir Webhook".

Output

The output of this node is a JSON object (or array of objects) representing the result of the webhook operation. The structure depends on whether you are setting or verifying a webhook:

Definir Webhook (setWebhook):
Returns confirmation details about the webhook setup, such as status, configured events, and possibly the webhook URL.
Verificar Webhook (findWebhook):
Returns current webhook configuration details for the specified instance, including enabled status, URL, and subscribed events.

Example output structure:

[
  {
    "status": "success",
    "instanceName": "example-instance",
    "webhookUrl": "https://yourdomain.com/webhook",
    "enabled": true,
    "events": ["MESSAGES_UPSERT", "CALL"],
    "webhookByEvents": false,
    "webhookBase64": false
  }
]

Fields may vary depending on the API response.

Dependencies

External Service: Requires access to the Evolution API.
API Key/Credentials: You must configure valid Evolution API credentials in n8n under the credential type evolutionApi.
Environment: Ensure your webhook URL is publicly accessible if you want to receive events from the Evolution API.

Troubleshooting

Common issues:

Invalid Credentials: If the provided API key is incorrect or missing, the node will fail to authenticate.
Unsupported Operation: If you select an unsupported resource or operation, you may see an error like:
```
Operação não suportada.
A função "webhook" para o recurso "events-api" não é suportada!
```
Resolution: Double-check that you have selected the correct resource and operation.
Webhook URL Not Reachable: If the webhook URL is not accessible from the internet, the Evolution API cannot deliver events.
Resolution: Make sure your endpoint is reachable and accepts POST requests.
Missing Required Fields: If required fields (like "Nome Da Instancia" or "Url Do Webhook") are empty, the node will throw validation errors.
Resolution: Fill in all mandatory fields.