Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Event → NATS

AI-generated

Overview

This node interacts with the Evolution API specifically for managing NATS (a messaging system) configurations related to events. It allows users to either set or check the NATS configuration for a given instance. This is useful in scenarios where event-driven communication needs to be enabled or verified within an application using the Evolution API.

Use Case Examples

  1. Enable NATS integration for an instance by setting specific event types to listen for.
  2. Check the current NATS configuration status for an instance to verify if the integration is enabled.

Properties

Name Meaning
Instance Name The name of the instance for which the NATS configuration is being managed.
Action Choose between setting the NATS configuration or checking the current NATS configuration status.
Enable NATS A boolean flag to enable or disable the NATS integration. Only applicable when setting NATS.
Events A multi-select list of event types to be enabled for NATS integration. Only applicable when setting NATS.

Output

JSON

  • enabled - Indicates whether the NATS integration is enabled or disabled.
  • natsEvents - List of event types configured for NATS integration.
  • instanceName - The name of the instance for which the NATS configuration applies.

Dependencies

  • Requires an API key credential for the Evolution API to authenticate requests.

Troubleshooting

  • If the node throws an 'Unsupported operation' error, verify that the 'resource' and 'operation' parameters are correctly set to 'Event' and 'NATS' respectively.
  • Ensure the 'Instance Name' is correctly provided and matches an existing instance in the Evolution API.
  • When setting NATS, ensure that the 'Events' list is not empty if enabling the integration, as this defines which events are subscribed to.

Discussion