Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node integrates with the Evolution API to manage webhook configurations for event notifications. It allows users to either set up a new webhook or check the status of an existing webhook for a specified instance. This is useful in scenarios where you want to receive real-time updates about various events (such as message updates, group changes, or presence updates) from the Evolution platform directly into your workflow.

Practical examples include:

  • Automatically triggering workflows when a new message arrives or is updated.
  • Monitoring group participant changes to update membership records.
  • Receiving call events to log or analyze call data.

Properties

Name Meaning
Instance Name The name of the instance that will send the webhook messages.
Action Choose between "Set Webhook" to create/update a webhook or "Check Webhook" to verify webhook status.
Enable Webhook Enable or disable the webhook integration (only applicable when setting a webhook).
Webhook URL The URL endpoint that will receive the webhook event payloads.
Webhook By Events Whether to create separate routes for each event by appending the event name to the webhook URL.
Base64 In Webhook Whether media data included in webhook events should be sent encoded in base64 format.
Events Select one or more event types to subscribe to for webhook notifications. Available options include: CALL, CHATS_DELETE, CHATS_SET, CHATS_UPDATE, CHATS_UPSERT, CONNECTION_UPDATE, CONTACTS_SET, CONTACTS_UPDATE, CONTACTS_UPSERT, GROUP_PARTICIPANTS_UPDATE, GROUP_UPDATE, GROUPS_UPSERT, LABELS_ASSOCIATION, LABELS_EDIT, MESSAGES_DELETE, MESSAGES_SET, MESSAGES_UPDATE, MESSAGES_UPSERT, PRESENCE_UPDATE, QRCODE_UPDATED, SEND_MESSAGE, TYPEBOT_CHANGE_STATUS, TYPEBOT_START.

Output

The node outputs JSON data representing the result of the webhook operation performed:

  • For Set Webhook, the output typically includes confirmation details such as success status and any relevant webhook identifiers or URLs.
  • For Check Webhook, the output provides the current status or configuration details of the webhook.

If the webhook sends event data, it would be delivered to the configured URL outside this node's execution context; this node manages only the setup and verification.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node depends on network access to the Evolution API endpoint (https://doc.evolution-api.com/api-reference).
  • Proper configuration of the webhook URL endpoint to receive incoming HTTP requests from the Evolution API.

Troubleshooting

  • Unsupported operation error: If the selected operation is not supported for the resource, the node throws an error indicating the unsupported function. Ensure the correct combination of resource and operation is selected.
  • Invalid or missing instance name: The node requires a valid instance name; missing or incorrect names may cause failures.
  • Webhook URL issues: Incorrect or unreachable webhook URLs will prevent successful webhook registration or event delivery.
  • Permission or authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Event subscription problems: Selecting no events or invalid event names may lead to unexpected behavior or no webhook triggers.

Links and References

Discussion