Z-API WhatsApp icon

Z-API WhatsApp

Custom operations

Overview

This node enables sending WhatsApp video messages with interactive buttons using the Z-API service. It is designed to facilitate rich user interactions by combining video content with clickable buttons, which can be used for quick replies or navigation within a conversation.

Common scenarios include:

  • Marketing campaigns where users receive promotional videos along with options to inquire about different products.
  • Customer support workflows that send tutorial or informational videos with buttons for common follow-up actions.
  • Interactive notifications where recipients can respond directly via button clicks linked to specific IDs.

For example, a business could send a product demo video with buttons labeled "Buy Now", "More Info", and "Contact Support" to engage customers effectively.

Properties

Name Meaning
Instance Your Z-API instance ID used to identify your WhatsApp API instance.
Token Your Z-API token for authenticating API requests.
Client Token Your Z-API client token for additional authentication security.
Phone The recipient's phone number or group ID where the message will be sent.
Message The text message accompanying the video and buttons, providing context or instructions.
Video URL The URL of the video file to be sent alongside the buttons.
Buttons A collection of interactive buttons; each button has:
- Button ID: unique identifier
- Button Label: text shown on the button

Output

The node outputs a JSON array containing the response from the Z-API service for each input item processed. The JSON typically includes status information about the message delivery.

No binary data output is produced by this operation.

Dependencies

  • Requires access to the Z-API WhatsApp service.
  • Needs valid credentials: an instance ID, a token, and a client token.
  • Network connectivity to https://api.z-api.io endpoints.
  • Proper configuration of these credentials in n8n or provided as node parameters.

Troubleshooting

  • Invalid Credentials: If authentication tokens or instance IDs are incorrect or expired, the API will reject requests. Verify and update credentials.
  • Invalid Phone Number: Ensure the phone number or group ID is correctly formatted and registered on WhatsApp.
  • Button Configuration Errors: Each button must have a unique ID and label. Missing or duplicate IDs may cause request failures.
  • Video URL Issues: The video URL must be accessible publicly and in a supported format. Broken links or unsupported formats will prevent sending.
  • API Rate Limits: Excessive requests might be throttled by Z-API. Implement retries or backoff strategies if needed.
  • Error Messages: The node throws errors if the operation is not supported or required parameters are missing. Check error details for guidance.

Links and References

Discussion