Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Actions64

Overview

The "Evento" resource with the "Webhook" operation in this node allows users to manage webhooks for the Evolution API. It supports setting up new webhooks or checking existing webhook configurations. This is useful for integrating real-time event notifications from the Evolution API into n8n workflows, enabling automation based on events such as message updates, group changes, contact updates, and more.

Practical examples include:

  • Automatically triggering workflows when a new message arrives.
  • Monitoring group participant changes to update CRM systems.
  • Receiving call event notifications to log call details.

Properties

Name Meaning
Server URL The full URL of your Evolution API server (e.g., https://api.exemplo.com).
API Key The API key credential for authenticating requests to the Evolution API instance or global scope.
Nome Da Instancia The name of the specific instance that will send the messages/events.
O Que Deseja Fazer Choose between "Definir Webhook" (set a new webhook) or "Verificar Webhook" (check existing webhook).
Ativar Webhook Enable or disable the webhook integration (only when setting a webhook).
Url Do Webhook The URL endpoint that will receive webhook event notifications.
Webhook Por Eventos Whether to create separate routes for each event by appending the event name to the webhook URL.
Base64 No Webhook Whether media data sent via webhook should be encoded in base64 format.
Eventos Select one or multiple event types to subscribe to for webhook notifications. Available events include CALL, CHATS_DELETE, MESSAGES_SET, GROUP_UPDATE, etc.

Output

The node outputs JSON data representing the response from the Evolution API related to webhook management. This typically includes confirmation of webhook setup, status information, or details about existing webhook configurations.

If media data is involved and the "Base64 No Webhook" option is enabled, media content in webhook payloads will be base64 encoded.

No binary data output is indicated.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user.
  • Requires a valid API key credential for authentication.
  • The node expects the user to provide the correct instance name within the Evolution API environment.
  • Network connectivity to the provided Server URL and webhook URL must be ensured.

Troubleshooting

  • Common Issues:

    • Incorrect Server URL or API Key will cause authentication failures.
    • Providing an invalid or unreachable webhook URL will prevent event delivery.
    • Selecting no events when setting a webhook may result in no notifications being received.
    • Misconfiguration of the instance name can lead to errors or no events triggered.

  • Error Messages:

    • "Operation not supported": Occurs if an unsupported operation is selected; ensure "Webhook" operation is chosen for the "Evento" resource.
    • API authentication errors: Verify API key validity and permissions.
    • Network errors: Check connectivity to both the Evolution API server and the webhook URL.

Links and References

Discussion