https://github.com/sooluh/adonisjs-whatsapp
:speech_balloon: Connect your WhatsApp Cloud API with AdonisJS.
https://github.com/sooluh/adonisjs-whatsapp
adonis adonisjs adonisjs-whatsapp cloud-api whatsapp whatsapp-api whatsapp-business whatsapp-business-api whatsapp-cloud whatsapp-cloud-api
Last synced: 8 months ago
JSON representation
:speech_balloon: Connect your WhatsApp Cloud API with AdonisJS.
- Host: GitHub
- URL: https://github.com/sooluh/adonisjs-whatsapp
- Owner: sooluh
- License: mit
- Created: 2023-02-08T12:07:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-08T12:54:31.000Z (about 1 year ago)
- Last Synced: 2025-09-19T14:00:05.090Z (9 months ago)
- Topics: adonis, adonisjs, adonisjs-whatsapp, cloud-api, whatsapp, whatsapp-api, whatsapp-business, whatsapp-business-api, whatsapp-cloud, whatsapp-cloud-api
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/adonisjs-whatsapp
- Size: 466 KB
- Stars: 30
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
## What's this
This package makes it easy for developers to access the [WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api) service in the AdonisJS 5 application.
## Getting Started
Please create and configure your Facebook WhatsApp application by following the ["Get Started"](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started) section of the official guide.
## Setup
Install the package using npm or yarn:
```bash
npm i adonisjs-whatsapp
# or
yarn add adonisjs-whatsapp
```
Then, configure the package using the configure command:
```bash
node ace configure adonisjs-whatsapp
```
After executing the above command, a `config/whatsapp.ts` file will be created, where you can define the WhatsApp Cloud API.
An important step is to set environment variables in your `.env` and validate them in the `env.ts` file.
```ts
WABA_ID: Env.schema.string(),
WABA_TOKEN: Env.schema.string(),
WABA_VERIFY: Env.schema.string(),
```
## Usage
The package supports events that are triggered when receiving a webhook from WhatsApp, some of which can be seen [here](./adonis-typings/events.ts).
The event can be subscribed to via the start/whatsapp.ts file.
```ts
// start/whatsapp.ts
import WhatsApp from '@ioc:Adonis/Addons/WhatsApp'
WhatsApp.on('message:text', function (message) {
// TODO: do whatever you want
})
```
To send text, images, and more, use the same singleton in your preload or controller file.
```ts
// app/Controllers/Http/ExampleController.ts
import WhatsApp from '@ioc:Adonis/Addons/WhatsApp'
import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
export default class ExampleController {
public async example(_ctx: HttpContextContract) {
await WhatsApp.sendText(628123456789, 'Lorem ipsum dolor sit amet.')
}
}
```
## Features
- [x] Mark messages as read
- [x] Upload media to the WhatsApp server
- [x] Download media from the WhatsApp server
- [x] Send text messages
- [x] Send images
- [x] Send documents
- [x] Send audios
- [x] Send videos
- [x] Send stickers
- [x] Send locations
- [x] Send template messages
- [x] Send contacts
- [x] Send reply button messages
- [x] Send list messages
- [x] Include a Webhook Endpoint
- [x] Event listener when receiving a webhook
## Changelog
Please see the [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.
## License
The MIT License (MIT). Please see [LICENSE](./LICENSE.md) file for more information.
## Disclaimer
This package is not officially maintained by Facebook. WhatsApp and Facebook trademarks and logos are the property of Meta Platforms, Inc.