Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

The node named "Evolution API" allows users to interact with the Evolution API, specifically focusing on managing webhooks related to events. It supports two main operations under the "Event" resource: setting a new webhook and checking an existing webhook. This node is useful for automating event-driven workflows where external systems need to be notified about specific events via webhooks.

Typical use cases include:

  • Registering a webhook URL to receive real-time notifications about various event types.
  • Enabling or disabling webhook integration dynamically.
  • Configuring whether media data in webhook payloads should be sent as base64.
  • Creating separate webhook routes for each event type by appending event names to the base URL.
  • Checking the status or existence of a previously set webhook.

For example, a user might set a webhook URL to receive updates whenever a chat message is sent or deleted, enabling automated processing or logging of these events.

Properties

Name Meaning
Instance Name The name of the instance that will send the webhook messages.
What Do You Want To Do Choose between setting a new webhook (Set Webhook) or checking the status of an existing webhook (Check Webhook).
Enable Webhook Boolean flag to enable or disable the webhook integration when setting a webhook.
Webhook URL The URL endpoint that will receive the webhook event notifications.
Webhook By Events Boolean flag indicating whether to create individual routes for each event by appending the event name to the webhook URL.
Base64 In Webhook Boolean flag specifying if media data included in webhook payloads should be encoded in base64 format.
Events A multi-select list of event types to subscribe to for webhook notifications. Available options include various event categories such as CALL, CHATS_DELETE, MESSAGES_SET, GROUP_UPDATE, PRESENCE_UPDATE, etc.

Output

The node outputs JSON data representing the result of the webhook operation performed:

  • When setting a webhook, the output typically includes confirmation details such as success status, webhook configuration, and any relevant metadata returned by the Evolution API.
  • When checking a webhook, the output contains information about the current webhook status or configuration.

If the webhook involves media data, the node can handle sending this data in base64 encoding based on the property settings.

No binary data output is indicated in the provided code or properties.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API authentication credential (API key or token) configured in n8n to authorize requests.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for API calls.
  • No additional external dependencies are indicated.

Troubleshooting

  • Operation Not Supported Error: If an unsupported operation or resource is selected, the node throws an error stating the function is not supported. Ensure the correct resource ("events-api") and operation ("webhook") are chosen.
  • Missing Required Parameters: The "Instance Name" and other required fields must be provided; otherwise, the API call may fail.
  • Webhook URL Issues: Invalid or unreachable webhook URLs will cause failures in setting up the webhook. Verify the URL is accessible and correctly formatted.
  • Authentication Failures: Ensure the API credentials are valid and have sufficient permissions to manage webhooks.
  • Event Subscription Errors: Selecting invalid or unsupported event types may lead to errors. Use only the listed event options.

Links and References

Discussion