Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," is designed to interact with the Evolution API service. It supports various resources and operations, including an integration with Chatwoot under the "Integração" resource and "Chatwoot" operation. The node allows users to configure and manage Chatwoot settings such as enabling/disabling the integration, setting account details, importing contacts and messages, and controlling conversation behaviors.

Typical use cases include:

  • Automating the setup or verification of Chatwoot integration for customer support workflows.
  • Importing contacts and message history into Chatwoot to maintain continuity in communication.
  • Managing conversation states like reopening messages or marking conversations as pending.
  • Customizing Chatwoot inboxes and agent signatures programmatically.

For example, a user can enable Chatwoot integration for a specific instance, import recent messages from the last 7 days, and automatically create an inbox for incoming conversations.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message (required).
O Que Deseja Fazer Choose between activating/deactivating Chatwoot ("Definir Chatwoot") or verifying Chatwoot ("Verificar Chatwoot"). Options: "Definir Chatwoot", "Verificar Chatwoot".
Ativar Chatwoot Enable or disable the integration with Chatwoot (boolean).
Link Do Chatwoot The URL link to the Chatwoot instance (required).
ID Da Conta Do Chatwoot The Chatwoot account ID (required).
Token De Admin Do Chatwoot The admin token for Chatwoot authentication (required, password type).
Assinatura Do Agente Do Chatwoot Enable or disable the Chatwoot agent signature (boolean).
Reabrir Mensagens No Chatwoot Enable or disable reopening messages in Chatwoot (boolean).
Iniciar Conversas Como Pendentes No Chatwoot Whether to start conversations as pending in Chatwoot (boolean).
Importar Contatos Para O Chatwoot Enable or disable importing contacts into Chatwoot (boolean).
Nome Da Inbox Do Chatwoot Optional: Name of the Chatwoot inbox.
Mesclar Contatos Brasileiros No Chatwoot Enable or disable merging Brazilian contacts in Chatwoot (boolean).
Importar Mensagens Para O Chatwoot Enable or disable importing messages into Chatwoot (boolean).
Importar Mensagens De Quantos Dias Para O Chatwoot Optional: Number of days to limit message import into Chatwoot (number).
Criar Caixa De Entrada Enable or disable automatic creation of an inbox (boolean).
Nome Do Contato De QRCode No Chatwoot Optional: Name of the QR code contact in Chatwoot.
Url Do Logo Para O Contato No Chatwoot Optional: URL of the logo for the contact in Chatwoot.

Output

The node outputs JSON data representing the result of the executed operation. This typically includes confirmation of the action performed (e.g., success status of enabling Chatwoot, details of the Chatwoot configuration, or verification results).

The output structure depends on the specific operation chosen but generally contains fields related to the Chatwoot integration status, imported data summaries, or error information if applicable.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Requires an API key credential for authenticating with the Evolution API.
  • For Chatwoot operations, requires valid Chatwoot account credentials including the admin token.
  • Network access to the specified Chatwoot URL.
  • Proper configuration of the node's input properties to match the target Chatwoot instance.

Troubleshooting

  • Common Issues:

    • Invalid or missing Chatwoot URL, account ID, or admin token will cause authentication failures.
    • Incorrect boolean flags may lead to unexpected behavior, e.g., not importing contacts or messages as intended.
    • Network connectivity issues to the Chatwoot server or Evolution API endpoint.
    • Using unsupported operations or resources will throw errors.
  • Error Messages:

    • "Operação não suportada." indicates the selected operation is not supported for the given resource. Verify the resource and operation names.
    • Authentication errors due to invalid tokens or credentials require checking the provided admin token and API key.
    • Validation errors for required fields (e.g., missing Chatwoot URL or account ID) must be resolved by providing correct values.

Links and References

Discussion