Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Event → Webhook

AI-generated

Overview

This node interacts with the Evolution API to manage webhooks related to events. It allows users to either set a new webhook or check the status of an existing webhook for a specified instance. This is useful for integrating external systems to receive real-time event notifications from the Evolution API, such as updates on calls, chats, contacts, messages, groups, and other event types.

Use Case Examples

  1. Setting a webhook URL to receive notifications for specific event types like CALL or MESSAGES_UPDATE.
  2. Checking if a webhook is already set for a given instance to verify integration status.

Properties

Name Meaning
Instance Name The name of the instance that will send the message, used to identify the source of events.
Action Choose between setting a new webhook or checking the webhook status.
Enable Webhook Toggle to enable or disable the webhook integration when setting a webhook.
Webhook URL The URL that will receive the webhook events when setting a webhook.
Webhook By Events Option to create a separate route for each event by appending the event name to the webhook URL.
Base64 In Webhook Option to send media data in base64 format within the webhook payload.
Events Select multiple event types for which the webhook should receive notifications.

Output

JSON

  • webhookStatus - Status or result of the webhook operation (set or check).
  • webhookDetails - Details about the webhook configuration or response from the API.

Dependencies

  • An API key credential for Evolution API authentication

Troubleshooting

  • Ensure the instance name is correctly specified to avoid identification errors.
  • Verify the webhook URL is reachable and correctly formatted to prevent delivery failures.
  • Check that the selected events are supported by the Evolution API to avoid invalid event errors.
  • If enabling the webhook, confirm that the API key credential has sufficient permissions to modify webhook settings.
  • Common error messages may include unsupported operation errors if the action chosen is not implemented, or network errors if the webhook URL is unreachable.

Discussion