Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The "Evolution API" node allows users to interact with the Evolution API, specifically supporting operations related to event webhooks. In the context of the "Evento" resource and the "Webhook" operation, this node enables users to either define a new webhook or verify an existing webhook configuration.

Typical use cases include:

  • Setting up webhooks to receive real-time event notifications from the Evolution API.
  • Verifying that a webhook is correctly configured and active.
  • Managing which events trigger webhook calls, including multimedia data handling options.

For example, a user might configure a webhook URL to receive notifications about incoming calls or message updates, enabling automated workflows triggered by these events.

Properties

Name Meaning
Nombre De La Instancia The name of the instance that will send the webhook messages; identifies the source instance.
Qué Desea Hacer Choose between defining a new webhook ("Definir Webhook") or verifying an existing webhook ("Verificar Webhook").
Activar Webhook Enable or disable the webhook integration (only when defining a webhook).
URL Del Webhook The URL endpoint that will receive the webhook event payloads.
Webhook Por Eventos Whether to create separate routes for each event by appending the event name to the webhook URL.
Base64 En Webhook Whether multimedia data sent via the webhook should be encoded in base64 format.
Eventos Select one or more event types that will trigger the webhook. Available events include CALL, CHATS_DELETE, MESSAGES_SET, 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 and webhook configuration.
  • When verifying a webhook, the output contains information about the current webhook setup and its status.

No binary data output is indicated for this node.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for API requests.
  • Proper network access to the Evolution API endpoints is necessary.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Incorrect or missing instance name may cause API errors.
    • Invalid webhook URL format can lead to webhook registration failure.
    • Selecting no events when defining a webhook may result in no triggers firing.
    • Network connectivity issues can prevent successful API communication.

  • Error Messages:

    • "Operação não suportada." indicates an unsupported operation-resource combination; ensure correct Resource and Operation selections.
    • API authentication errors suggest invalid or missing API credentials.
    • Validation errors on webhook URL or parameters require checking input values.

  • Resolutions:

    • Verify all required fields are filled correctly.
    • Confirm API credentials are valid and have necessary permissions.
    • Ensure the webhook URL is publicly accessible and correctly formatted.
    • Check network connectivity and firewall settings.

Links and References

Discussion