https://github.com/leandcesar/n8n-nodes-zapi
Custom n8n node for Z-API
https://github.com/leandcesar/n8n-nodes-zapi
n8n n8n-community-node-package n8n-node whatsapp z-api
Last synced: 7 months ago
JSON representation
Custom n8n node for Z-API
- Host: GitHub
- URL: https://github.com/leandcesar/n8n-nodes-zapi
- Owner: leandcesar
- License: mit
- Created: 2024-07-03T22:53:53.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T22:02:25.000Z (almost 2 years ago)
- Last Synced: 2025-03-21T03:47:57.942Z (about 1 year ago)
- Topics: n8n, n8n-community-node-package, n8n-node, whatsapp, z-api
- Language: TypeScript
- Homepage:
- Size: 95.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# n8n-nodes-zapi
This is an n8n community node. It lets you use Z-API in your n8n workflows.
Z-API is a service that provides an API enabling interaction with your WhatsApp through a API, along with webhooks to notify you about interactions with your number.
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
- [Installation](#installation)
- [Operations](#operations)
- [Credentials](#credentials)
- [Resources](#resources)
## Installation
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
## Operations
The following operations are supported by the Z-API node:
### Messages
#### Send Message
- [x] Send audio
- [ ] Send contact
- [ ] Send contacts
- [x] Send document
- [x] Send GIF
- [x] Send image
- [ ] ~~Send image with buttons~~ (unavailable)
- [ ] Send link
- [x] Send list of options
- [x] Send location
- [x] Send PTV
- [x] Send sticker
- [x] Send text
- [ ] ~~Send text with action buttons~~ (unavailable)
- [ ] ~~Send text with buttons~~ (unavailable)
- [x] Send video
#### Manage Message
- [ ] Send reaction
- [ ] Remove reaction
- [ ] Delete message
- [ ] Read message
- [ ] Forward message
- [ ] Pin message
- [ ] Unpin message
#### Products
- [ ] Send product
- [ ] Send catalog
- [ ] Send order approval
- [ ] Send order status update
- [ ] Send payment status update
#### Events
- [ ] Send event
- [ ] Edit event
- [ ] Respond to event
#### Polls
- [ ] Send poll
- [ ] Send poll vote
## Credentials
To use this node, you need to authenticate with the Z-API service. Follow these steps:
1. **Sign Up**: Create an account on [Z-API](https://www.z-api.io/).
2. **Create an Instance**: After signing up, create an instance in the Z-API dashboard. Each instance will have its own ID and Token.
3. **Get ID and Token**: Go to your instance settings in the admin panel to find your ID and Token.
4. Navigate to the "Security" tab and find the "Client Token" module.
5. Click "Configure Now" to generate a token. Initially, the token will be disabled to avoid disruptions.
6. Activate the token in the Z-API dashboard.
7. **Add Credentials to n8n**: In n8n, go to the credentials section and add new credentials for Z-API. Use the ID and Token from your Z-API instance and the Client Token from your account.
## Resources
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
* [Z-API documentation](https://developer.z-api.io/)