Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node interacts with the "Evolution API" to manage webhooks related to events. Specifically, for the "Evento" resource and the "Webhook" operation, it allows users to either set up a new webhook or verify an existing webhook configuration. This is useful in scenarios where you want to receive real-time event notifications from the Evolution API by forwarding them to a specified URL.

Practical examples include:

  • Setting a webhook URL to receive updates about calls, messages, group changes, or contact updates.
  • Enabling or disabling the webhook integration dynamically.
  • Choosing whether to create separate webhook routes per event type.
  • Configuring if media data should be sent as base64 within webhook payloads.
  • Checking the current webhook setup without modifying it.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message. This identifies which instance the webhook relates to.
O Que Deseja Fazer Choose between two actions:
- Definir Webhook (Set a new webhook)
- Verificar Webhook (Check the existing webhook)
Ativar Webhook Enable or disable the webhook integration. Only applicable when setting a webhook.
Url Do Webhook The URL that will receive the webhook event notifications. Only used when setting a webhook.
Webhook Por Eventos Whether to create a separate route for each event by appending the event name to the webhook URL. This allows handling different events on distinct endpoints.
Base64 No Webhook Whether to send media data in base64 format within the webhook payload. Useful if the receiving endpoint requires media encoded this way.
Eventos Select one or more event types to subscribe to for webhook notifications. Events include CALL, CHATS_DELETE, MESSAGES_SET, GROUP_UPDATE, PRESENCE_UPDATE, and many others related to messaging and group activities.

Output

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

  • When setting a webhook, the output typically includes confirmation details such as success status, webhook URL, enabled state, and subscribed events.
  • When verifying a webhook, the output contains the current webhook configuration details retrieved from the Evolution API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API to be accessible and properly configured to accept webhook registrations.
  • Network connectivity to the specified webhook URL must be ensured for successful event delivery.

Troubleshooting

  • Common issues:

    • Invalid or unreachable webhook URL may cause failures when setting the webhook.
    • Missing or incorrect API authentication credentials will prevent communication with the Evolution API.
    • Selecting no events when setting a webhook might result in no notifications being received.
    • Disabling the webhook while expecting events will stop event delivery.

  • Error messages:

    • "Operação não suportada." indicates that the chosen operation is not implemented for the selected resource. Verify that "Webhook" is supported under "Evento".
    • Network or authentication errors will typically surface as API request failures; ensure credentials and URLs are correct.

  • Resolutions:

    • Double-check the webhook URL for correctness and accessibility.
    • Confirm that the API key credential is valid and has necessary permissions.
    • Ensure at least one event is selected when setting a webhook.
    • Review the enable/disable toggle to match your intended webhook state.

Links and References

Discussion