Evolution API AI Tool icon

Evolution API AI Tool

Use Evolution API for WhatsApp in AI agents

Overview

This node integrates with the Evolution API to send WhatsApp messages and perform related operations. It is particularly useful for automating communication workflows where sending text or media messages via WhatsApp is required, such as customer support notifications, marketing campaigns, or alert systems.

For the Send Text Message operation, the node sends a plain text message to a specified phone number through a configured WhatsApp instance.

Example use cases:

  • Sending order confirmations or delivery updates to customers.
  • Notifying users about appointment reminders.
  • Broadcasting announcements or alerts to a list of contacts.

Properties

Name Meaning
Instance The name identifier of the WhatsApp instance to use for sending the message.
Phone Number Recipient's phone number including country code (e.g., 5511999999999).
Message The text content of the message to be sent.

Output

The node outputs JSON data representing the response from the Evolution API after attempting to send the message. This typically includes status information about the message delivery.

The output structure is an array of JSON objects, each corresponding to an input item processed. If an error occurs during processing, the output for that item will contain an error field with the error message.

No binary data is produced by this operation.

Dependencies

  • Requires an active Evolution API account with WhatsApp integration.
  • Needs an API key credential and the base URL of the Evolution API service configured in the node credentials.
  • Uses HTTP requests to communicate with the Evolution API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing API key or URL in credentials can cause authentication failures.
    • Incorrect phone number format may result in message delivery errors.
    • Using an unsupported operation name will throw an error indicating the operation is not supported.
  • Error messages:

    • "The operation \"<operation>\" is not supported!": Occurs if an invalid operation is selected; ensure the operation matches one of the supported options.
    • Network or API errors will return their messages in the output under the error field if "Continue On Fail" is enabled.
  • Resolution tips:

    • Verify credentials are correctly set up with valid API key and URL.
    • Confirm phone numbers include the correct country code without additional symbols.
    • Use only supported operations as defined by the node.

Links and References

  • Evolution API Documentation (example placeholder link)
  • WhatsApp Business API official documentation for message formatting and requirements.

Discussion