Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node interacts with the "Evolution API" to manage webhooks related to events. Specifically, for the Evento resource and Webhook operation, it allows users to either set up a new webhook or verify an existing webhook configuration.

Common scenarios where this node is beneficial include:

  • Automatically receiving event notifications from an external system by setting up webhooks.
  • Checking the status or details of currently configured webhooks without manual API calls.
  • Managing event subscriptions dynamically based on business needs.

Practical examples:

  • Setting a webhook URL to receive real-time updates about chat messages or group participant changes.
  • Enabling or disabling webhook integration depending on operational requirements.
  • Choosing specific event types (e.g., CALL, MESSAGES_SET) to listen for via the webhook.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message. This identifies the source instance for the webhook setup.
O Que Deseja Fazer Choose between two actions:
- Definir Webhook (setWebhook): Define a new webhook.
- Verificar Webhook (findWebhook): Check the current webhook configuration.
Ativar Webhook Boolean flag to enable or disable the webhook integration when setting a webhook.
Url Do Webhook The URL that will receive the webhook events. Required when defining a webhook.
Webhook Por Eventos Boolean flag indicating whether to create a separate route for each event by appending the event name to the webhook URL.
Base64 No Webhook Boolean flag indicating whether media data should be sent in base64 format within the webhook payload.
Eventos Multi-select list of event types to subscribe to for the webhook. Options include various event names such as CALL, CHATS_DELETE, MESSAGES_SET, GROUP_UPDATE, etc. Users can select multiple events to listen for.

Output

The node outputs a JSON array containing the result of the webhook operation:

  • When setting a webhook, the output typically includes confirmation details such as success status, webhook ID, or configuration summary.
  • When verifying a webhook, the output contains the current webhook settings or status information.

If the webhook involves media data, the node supports sending media in base64 encoding if enabled, but binary data output is not explicitly indicated.

Dependencies

  • Requires an API key credential to authenticate with the Evolution API service.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for API requests.
  • Proper network access to the Evolution API endpoint is necessary.
  • The user must provide valid webhook URLs accessible by the Evolution API service.

Troubleshooting

  • Common issues:

    • Invalid or unreachable webhook URL may cause failures in setting the webhook.
    • Missing required parameters like instance name or webhook URL when setting a webhook.
    • Selecting no events when defining a webhook might result in no webhook being created or ineffective webhook behavior.
    • API authentication errors due to invalid or missing API credentials.

  • Error messages:

    • "Operação não suportada." indicates that the selected operation is not supported for the chosen resource. Verify that the resource and operation are correctly selected.
    • Network or permission errors when calling the Evolution API usually indicate connectivity issues or invalid credentials.

  • Resolutions:

    • Ensure all required fields are filled correctly.
    • Verify the webhook URL is publicly accessible and correctly formatted.
    • Confirm API credentials are valid and have sufficient permissions.
    • Select at least one event type when setting a webhook.

Links and References

Discussion