{"id":14987158,"url":"https://github.com/sooluh/adonisjs-whatsapp","last_synced_at":"2025-10-10T07:33:25.697Z","repository":{"id":65758952,"uuid":"599077648","full_name":"sooluh/adonisjs-whatsapp","owner":"sooluh","description":":speech_balloon: Connect your WhatsApp Cloud API with AdonisJS.","archived":false,"fork":false,"pushed_at":"2025-03-08T12:54:31.000Z","size":477,"stargazers_count":30,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-19T14:00:05.090Z","etag":null,"topics":["adonis","adonisjs","adonisjs-whatsapp","cloud-api","whatsapp","whatsapp-api","whatsapp-business","whatsapp-business-api","whatsapp-cloud","whatsapp-cloud-api"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/adonisjs-whatsapp","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sooluh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-02-08T12:07:24.000Z","updated_at":"2025-04-04T17:32:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c3bc466-8001-404e-a63c-492779ec06c5","html_url":"https://github.com/sooluh/adonisjs-whatsapp","commit_stats":{"total_commits":25,"total_committers":2,"mean_commits":12.5,"dds":"0.19999999999999996","last_synced_commit":"944c7a697cf45d6d25723c56e8eac6ad6d81a164"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/sooluh/adonisjs-whatsapp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fadonisjs-whatsapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fadonisjs-whatsapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fadonisjs-whatsapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fadonisjs-whatsapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sooluh","download_url":"https://codeload.github.com/sooluh/adonisjs-whatsapp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fadonisjs-whatsapp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002667,"owners_count":26083442,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adonis","adonisjs","adonisjs-whatsapp","cloud-api","whatsapp","whatsapp-api","whatsapp-business","whatsapp-business-api","whatsapp-cloud","whatsapp-cloud-api"],"created_at":"2024-09-24T14:14:11.301Z","updated_at":"2025-10-10T07:33:25.681Z","avatar_url":"https://github.com/sooluh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://s.id/standwithpalestine\"\u003e\u003cimg alt=\"I stand with Palestine\" src=\"https://cdn.jsdelivr.net/gh/Safouene1/support-palestine-banner@master/banner-support.svg\" width=\"100%\" /\u003e\u003c/a\u003e\n\n![adonisjs-whatsapp](https://socialify.git.ci/sooluh/adonisjs-whatsapp/image?description=1\u0026descriptionEditable=Connect%20your%20WhatsApp%20Cloud%20API%20with%20AdonisJS\u0026font=Jost\u0026forks=1\u0026issues=1\u0026logo=https%3A%2F%2Fik.imagekit.io%2Fsooluh%2Fwhatsapp.png\u0026name=1\u0026owner=1\u0026pattern=Charlie%20Brown\u0026pulls=1\u0026stargazers=1\u0026theme=Auto)\n\n## What's this\n\nThis 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.\n\n## Getting Started\n\nPlease 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.\n\n## Setup\n\nInstall the package using npm or yarn:\n\n```bash\nnpm i adonisjs-whatsapp\n# or\nyarn add adonisjs-whatsapp\n```\n\nThen, configure the package using the configure command:\n\n```bash\nnode ace configure adonisjs-whatsapp\n```\n\nAfter executing the above command, a `config/whatsapp.ts` file will be created, where you can define the WhatsApp Cloud API.\n\nAn important step is to set environment variables in your `.env` and validate them in the `env.ts` file.\n\n```ts\nWABA_ID: Env.schema.string(),\nWABA_TOKEN: Env.schema.string(),\nWABA_VERIFY: Env.schema.string(),\n```\n\n## Usage\n\nThe package supports events that are triggered when receiving a webhook from WhatsApp, some of which can be seen [here](./adonis-typings/events.ts).\n\nThe event can be subscribed to via the start/whatsapp.ts file.\n\n```ts\n// start/whatsapp.ts\n\nimport WhatsApp from '@ioc:Adonis/Addons/WhatsApp'\n\nWhatsApp.on('message:text', function (message) {\n  // TODO: do whatever you want\n})\n```\n\nTo send text, images, and more, use the same singleton in your preload or controller file.\n\n```ts\n// app/Controllers/Http/ExampleController.ts\n\nimport WhatsApp from '@ioc:Adonis/Addons/WhatsApp'\nimport { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'\n\nexport default class ExampleController {\n  public async example(_ctx: HttpContextContract) {\n    await WhatsApp.sendText(628123456789, 'Lorem ipsum dolor sit amet.')\n  }\n}\n```\n\n## Features\n\n- [x] Mark messages as read\n- [x] Upload media to the WhatsApp server\n- [x] Download media from the WhatsApp server\n- [x] Send text messages\n- [x] Send images\n- [x] Send documents\n- [x] Send audios\n- [x] Send videos\n- [x] Send stickers\n- [x] Send locations\n- [x] Send template messages\n- [x] Send contacts\n- [x] Send reply button messages\n- [x] Send list messages\n- [x] Include a Webhook Endpoint \n- [x] Event listener when receiving a webhook\n\n## Changelog\n\nPlease see the [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.\n\n## License\n\nThe MIT License (MIT). Please see [LICENSE](./LICENSE.md) file for more information.\n\n## Disclaimer\n\nThis package is not officially maintained by Facebook. WhatsApp and Facebook trademarks and logos are the property of Meta Platforms, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsooluh%2Fadonisjs-whatsapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsooluh%2Fadonisjs-whatsapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsooluh%2Fadonisjs-whatsapp/lists"}