Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API, specifically focusing on the 'Event' resource and its 'Webhook' operation. It allows users to either set up a new webhook or check an existing webhook for receiving event notifications from the Evolution API. This is useful for automating workflows based on real-time event data, such as message updates, group changes, or contact updates.

Use Case Examples

  1. Setting a webhook URL to receive notifications for specific events like message updates or group participant changes.
  2. Checking the status or details of an existing webhook to ensure it is correctly configured.

Properties

Name Meaning
Instance Name The name of the instance that will send the message, required to identify the source.
What Do You Want To Do Choose between setting a new webhook or checking an existing webhook.
Enable Webhook Toggle to enable or disable the webhook integration (only when setting a webhook).
Webhook URL The URL that will receive the webhook events (only when setting a webhook).
Webhook By Events Option to create a separate route for each event by appending the event name to the URL (only when setting a webhook).
Base64 In Webhook Option to send media data in base64 format within the webhook payload (only when setting a webhook).
Events Select one or more event types to subscribe to for webhook notifications (only when setting a webhook).

Output

JSON

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

Dependencies

  • Evolution API

Troubleshooting

  • Ensure the 'Instance Name' is correctly set as it identifies the source sending messages.
  • When setting a webhook, verify the 'Webhook URL' is reachable and correctly formatted to receive events.
  • If the webhook is not triggering, check if the 'Enable Webhook' option is set to true.
  • For media data issues, confirm if 'Base64 In Webhook' is enabled if base64 encoding is required.
  • If an unsupported operation or resource is selected, the node will throw an error indicating the function is not supported.

Discussion