Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node provides an interface to send presence updates in a chat context via the Evolution API. Specifically, it allows signaling to a contact whether the user is currently typing or recording a message. This functionality is useful in chat applications to enhance real-time communication feedback, making conversations feel more interactive and responsive.

Common scenarios include:

  • Indicating to a chat recipient that you are typing a reply.
  • Showing that you are recording a voice message before sending it.
  • Temporarily displaying presence status for a specified duration to improve user experience.

For example, when integrated into a workflow, this node can notify a contact that the sender is composing a message, which can help manage expectations about response times.

Properties

Name Meaning
Instance Name The name of the Evolution API instance to use for sending the presence update.
Contact The identifier (contact number) of the chat recipient to whom the presence will be sent.
Presence The type of presence to send; options are: "Typing..." (composing) or "Recording...".
Delay Duration in milliseconds that the presence status remains active before clearing/resetting.

Output

The node outputs a JSON array containing the result of the presence update operation. The exact structure depends on the Evolution API's response but generally confirms whether the presence was successfully sent.

No binary data output is involved.

Dependencies

  • Requires an authenticated connection to the Evolution API via an API key or similar credential.
  • The node expects the Evolution API instance to be configured within n8n with appropriate credentials.
  • Network access to the Evolution API endpoint is necessary.

Troubleshooting

  • Unsupported operation error: If the node throws an error indicating the operation is unsupported, verify that the resource is set to "chat-api" and the operation to "send-presence".
  • Invalid contact identifier: Ensure the contact number (remoteJid) is correctly formatted and corresponds to a valid chat recipient.
  • Presence not updating: Check that the API credentials are valid and have sufficient permissions to send presence updates.
  • Delay misconfiguration: Setting the delay too low might cause the presence to clear immediately; adjust the delay to a reasonable value (e.g., 1200 ms).

Links and References

Discussion