Superchat icon

Superchat

Retrieve data from the Superchat API

Overview

This node allows sending WhatsApp messages using predefined WhatsApp templates via the Superchat API. It is designed to automate and standardize outbound WhatsApp communications by leveraging template messages, which are useful for notifications, alerts, confirmations, or any structured messaging that requires consistent formatting.

Common scenarios include:

  • Sending appointment reminders or confirmations.
  • Dispatching shipping or delivery updates.
  • Notifying customers about account activities or promotions.
  • Automating customer support follow-ups with templated responses.

For example, a business can use this node to send a WhatsApp template message confirming an order, where variables in the template are dynamically filled with order details.

Properties

Name Meaning
Sender Name The name displayed beneath the WhatsApp message in Superchat (e.g., "Sent from n8n").
To (Phone Number or Contact ID) The recipient's identifier; either a phone number or a contact ID within Superchat.
Channel ID The ID of the channel through which the message will be sent. Can be entered manually or selected from a searchable list.
Template ID The ID of the WhatsApp template to use for the message. Can be entered manually or selected from a searchable list.
Header File ID Optional. The ID of a file to use as a header in the template if the template supports a header. Can be entered manually or selected from a searchable list.
Variables A collection of variable values to fill placeholders in the WhatsApp template. The number of variables must match the template definition. Multiple variables can be added.

Output

The node outputs a JSON array where each item corresponds to the result of sending a WhatsApp template message for each input item. The structure typically includes details about the sent message such as message ID, status, timestamps, or error information if sending failed.

If the node supports binary data output (not indicated here), it would represent attachments or media related to the message, but this operation focuses on sending templated text messages with optional header files referenced by ID.

Dependencies

  • Requires an active connection to the Superchat API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The user must have access to valid WhatsApp templates and channels configured in Superchat.
  • The node uses internal search methods to help select Channel IDs, Template IDs, and File IDs from existing resources.

Troubleshooting

  • Invalid Template ID or Channel ID: If the provided template or channel ID does not exist or is incorrect, the API will reject the request. Verify IDs by using the searchable lists or directly in the Superchat dashboard.
  • Mismatched Variables Count: The number of variables supplied must exactly match the placeholders defined in the WhatsApp template. Otherwise, the message will fail to send.
  • Unauthorized Errors: Ensure the API key credential is correctly set up and has permissions to send WhatsApp messages.
  • Invalid Recipient Identifier: The "To" field must be a valid phone number or a recognized contact ID. Invalid formats will cause errors.
  • Header File Issues: If the template expects a header file and none is provided, or if the file ID is invalid, the message may not send properly.

Links and References

Discussion