Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Event → WebSocket

AI-generated

Overview

This node interacts with the Evolution API to manage WebSocket connections for event handling. It allows users to either set up a WebSocket connection with specific event subscriptions or check the current WebSocket configuration. This is useful for real-time event-driven workflows where updates from the Evolution API need to be received and processed immediately, such as monitoring chat updates, message events, or connection status changes.

Use Case Examples

  1. Setting up a WebSocket to listen for chat and message events to trigger automated responses or logging.
  2. Checking the current WebSocket configuration to verify if the integration is enabled and which events are subscribed.

Properties

Name Meaning
Instance Name The name of the Evolution API instance to connect to.
Action Choose between setting the WebSocket connection or checking its configuration.
Enable WebSocket Toggle to enable or disable the WebSocket integration (only when setting the WebSocket).
Events Select which events to subscribe to on the WebSocket connection (only when setting the WebSocket).

Output

JSON

  • webSocketStatus - Status of the WebSocket connection or configuration check result.
  • enabled - Boolean indicating if the WebSocket integration is enabled.
  • subscribedEvents - List of events the WebSocket is subscribed to.

Dependencies

  • Evolution API credentials for authentication

Troubleshooting

  • Ensure the Evolution API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that the instance name provided matches an existing Evolution API instance to prevent connection failures.
  • When setting the WebSocket, ensure at least one event is selected to subscribe to; otherwise, the WebSocket may not function as expected.
  • Check network connectivity and firewall settings that might block WebSocket connections.

Discussion