@aysali/n8n-nodes-aysali-api
v1.0.4
Published
n8n community node for the Aysali API (WhatsApp channel hub)
Maintainers
Keywords
Readme
Aysali API — n8n node
Aysali is an alternative stack to Aysali API for WhatsApp channel automation and integrations. This node targets Aysali API, not the Aysali API server itself.
If you are coming from Aysali-based workflows, compare endpoints and credentials in Aysali documentation before migrating.
Community node for n8n that connects your workflows to the Aysali API (WhatsApp channel hub and integrations). After the package is available in your n8n instance, add the Aysali API node from the node panel.
Prerequisites
- A running Aysali API deployment (or a server URL you are allowed to use).
- A valid API key (account- or instance-level, depending on your Aysali setup).
- An n8n version that supports community nodes (a current release is recommended).
Technical API details: Aysali documentation and API reference.
Credentials
- In n8n: Credentials → New.
- Search for Aysali API and select it.
- Fill in:
- Server URL — full base URL of your API (e.g.
https://your-aysali.example.com) without extra path segments unless your deployment requires them. - API Key — key issued by Aysali (stored as a secret field).
- Server URL — full base URL of your API (e.g.
- Use Test if shown to verify the connection before saving.
The node sends the key in the request headers as expected by Aysali (apikey).
Using the node
- In the editor, add the Aysali API node (from the node palette).
- Select the credential you created.
- Choose a Resource (see below).
- Choose an Operation for that resource.
- Fill in the fields shown for that operation (instance, chat id, message id, media, etc.). Fields change per operation.
- Execute the node or the whole workflow. Output is usually JSON from the API for downstream nodes.
The node subtitle shows the selected operation.
Resources and operations
The UI flow is: Resource → Operation → operation-specific fields.
Instance
Manage the WhatsApp connection for an instance: create, connect (QR/Base64), list instances, behavior, presence, proxy, restart, logout, delete.
| UI operation | Summary | |--------------|---------| | Create Instance | Create a new instance | | Connect Instance | Generate connection (QR or Base64) | | Fetch Instance | List instances | | Set Behavior | Configure instance behavior | | Set Presence | Set presence | | Set/Fetch Proxy | Configure or read proxy | | Restart Instance | Restart the socket | | Disconnect Instance | Disconnect WhatsApp | | Delete Instance | Delete the instance |
Message
Send text, media, poll, buttons, lists, PIX, status (story), reactions, contacts, etc.
| UI operation | Summary | |--------------|---------| | Send Text / Image / Video / Audio / Document | Text and media messages | | Send Poll | Poll with up to 12 options | | Send Contact / List / Buttons | Contact card, list, buttons | | Send PIX | PIX payment button | | Send Status | Post a status/story | | React To Message | Reaction on a message |
Chat
Read state, archive, search, profile picture, media as Base64, edit/delete messages, typing presence, block, list contacts/messages/chats/status.
| UI operation | Summary | |--------------|---------| | Check Number | Check if a number is on WhatsApp | | Read Messages | Mark messages as read | | Manage Archive / Mark As Unread | Archive or unread | | Delete Message / Edit Message | Delete or edit a message | | Fetch Profile Picture / Get Media As Base64 | Profile image or media | | Send Presence | Typing/recording presence | | Block Contact | Block or unblock | | List Contacts / Find Messages / Find Status / Find Chats | Query contacts, messages, status, chats |
Group
Create groups, image/name/description, settings, members, invites, join/leave, ephemeral messages.
| UI operation | Summary | |--------------|---------| | Create Group | New group | | Update Group Image / Name / Description | Update group metadata | | Update Settings / Update Members | Permissions and members | | Fetch / Revoke / Send Invite Link | Invite link | | Fetch Groups / Find Participants | Groups and members | | Ephemeral Messages | Disappearing messages | | Join Group / Leave Group | Join with code or leave |
Profile
Fetch and update name, status, picture, business profile, privacy settings.
| UI operation | Summary | |--------------|---------| | Fetch Profile / Fetch Business Profile | Read profile data | | Update Profile Name / Status / Picture / Remove Profile Picture | Update or remove picture | | Fetch Privacy Settings / Update Privacy Settings | Instance privacy |
Event (outbound integrations)
Configure Webhook or RabbitMQ integration for the instance using the fields shown in the UI.
Integration (third-party)
Connect chat and bot stacks through Aysali:
- Chatwoot, Aysali Bot, Typebot, Dify, Flowise
Each option shows its own configuration fields; see Aysali documentation for valid values and limits.
Output and errors
- Output — JSON responses from the API; pass them to Set, IF, Code, or other nodes.
- Errors — Failed requests (e.g. server rejection or missing parameters) surface as n8n errors with API details; check HTTP status and body against Aysali documentation for common codes.
License
MIT — see LICENSE.md.
