Package Information
Documentation
n8n-nodes-airyschat
This is the official Community Node for AirysChat, designed to integrate the powerful multi-channel customer support infrastructure (based on Chatwoot v4+ with AI) directly into your visual automation workflows in n8n.
🚀 Available Features
This package allows you to control and orchestrate AirysChat conversations, messages, and contacts directly from your n8n automations. Ideal for active WhatsApp workflows, intelligent chatbots, and mass sending of reports or invoices.
1. Message (WhatsApp Messages and Templates)
- Send WhatsApp Template: The crown jewel. Allows you to send pre-approved Meta/WhatsApp templates to initiate active conversations with your customers (HSM).
- 🔥 Dynamic Loading: Inboxes and the list of approved Templates in your AirysChat account are automatically loaded into a Dropdown. No need to hunt for numeric IDs manually.
- 🖼️ Header Media: Full support for templates that require Images, Videos, or PDF Documents in the header. Just provide the public URL of the file.
- 🧩 Body Variables: Dynamically inject texts (e.g., Names, Values, Dates coming from n8n) directly into the blank spaces
{{1}},{{2}}of your template. - 🔘 Button Parameters: Insert custom payloads into Quick Reply buttons or parameterize Call-to-Action URLs dynamically.
- Create: Send simple text messages into existing conversations.
2. Contact
- Search or Create: Allows you to automate workflows that depend on an existing contact before sending a message. n8n will search AirysChat by the customer's Phone Number.
- If the contact already exists, it updates the profile with the new data and returns the ID.
- If it does not exist, it creates the contact on the fly.
- 🏷️ Custom Attributes: Send unique properties from your ERP, database, or CRM directly to the customer's profile in AirysChat during creation/update.
3. Triggers
- AirysChat Trigger: Starts the workflow when an AirysChat event occurs. Automatically registers and manages webhooks in your AirysChat instance. Supported events include:
- Contact Created / Updated
- Conversation Created / Updated / Status Changed
- Message Created / Updated
- Webwidget Triggered
⚙️ How to Install
Follow these steps to install the Node directly in your n8n interface:
- Go to Settings in the left menu of n8n.
- Click on Community Nodes.
- Click on Install a community node.
- In the "npm Package Name" field, type exactly:
n8n-nodes-airyschat - Acknowledge the security warnings and click Install.
- After installation, close the tab or perform a Hard Reload (F5) in the browser to refresh the icon cache of the n8n panel.
🔑 How to Authenticate (Credentials)
Before using the nodes on the canvas, you will need to connect n8n to your AirysChat infrastructure. To do this, create a credential of type AirysChat API:
- Base URL: The URL of your AirysChat installation (e.g.,
https://app.airyschat.com). Do not append/api/v1or/at the end, just the main URL. - Access Token: The API access token of your user or bot (available in the Profile Settings of AirysChat).
- Account ID: The numeric ID of the account/tenant you want to operate on (usually
1if it is the main panel, or visible in the URL).
🛠️ Contributing and Local Development
If you are a developer looking to further extend the power of this Node (creating features like Tag manipulation, Teams, or SLA Automation):
- Clone the main repository:
git clone https://github.com/gabrieldeholanda/AirysChat.git - Enter the n8n node folder:
cd AirysChat/n8n-nodes-airyschat - Install the dependencies and build:
npm install --legacy-peer-deps npm run build - Generate the link to your local n8n instance:
npm link # Go to the global folder where your n8n runs and execute: npm link n8n-nodes-airyschat