Z-API icon

Z-API

Send messages

Overview

This node integrates with the Z-API service to send WhatsApp messages programmatically. It is designed primarily for sending text messages through a specified Z-API instance by providing necessary authentication tokens and message details. This node is useful in scenarios such as automating customer notifications, sending alerts, or integrating WhatsApp messaging into workflows without manual intervention.

For example, you can use this node to send a welcome message to new users automatically or notify a sales team when a new lead is captured.

Properties

Name Meaning
Instance ID Your Z-API Instance ID used to identify the WhatsApp instance.
Instance Token Your Z-API Instance Token used for authenticating API requests (kept secret).
Client Token Your Z-API Client Token used for authenticating API requests (kept secret).

Output

The node outputs an array of JSON objects representing the response from the Z-API after attempting to send each message. Each object contains the result of the API call, which typically includes information about the message status or any errors returned by the API.

If the node encounters an error during execution and "Continue On Fail" is enabled, it outputs an object with an error field containing the error message for that item.

The node does not output binary data.

Dependencies

  • Requires access to the Z-API WhatsApp messaging service.
  • Requires three pieces of authentication information: Instance ID, Instance Token, and Client Token.
  • No additional external dependencies beyond these credentials and network access to the Z-API endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing Instance ID, Instance Token, or Client Token will cause authentication failures.
    • Providing an unsupported operation or resource will throw an error indicating the unknown operation or resource.
    • Network connectivity issues may prevent successful API calls.

  • Error messages:

    • "The operation \"<operation>\" is not known!": This means the specified operation is not supported by the node. Verify the operation name.
    • "The resource \"<resource>\" is not known!": This indicates the resource parameter is invalid or unsupported.
    • Errors related to authentication failure usually mean the provided tokens or instance ID are incorrect or expired.

To resolve errors:

  • Double-check all credential values.
  • Ensure the resource and operation parameters are set correctly.
  • Confirm network connectivity to the Z-API service.

Links and References

Discussion