OdooWiki OCA HUB

Mail Whatsapp Gateway

mail_gateway_whatsapp folder_open OCA/social open_in_new
Uncategorised License: AGPL-3

This module allows to respond whatsapp chats.

This way, a group of users can respond customers or any other set of partners in an integrated way.

auto_awesome What this module does

AI-generated from the code · Odoo 18.0

Connect Odoo to WhatsApp through a gateway so users can send and receive WhatsApp messages from Odoo, manage WhatsApp message templates, and trigger WhatsApp messages automatically from server actions.

This module adds WhatsApp as a channel type on the existing mail gateway, so a company can link its WhatsApp Business account to Odoo and chat with customers from inside Odoo.

  • Incoming WhatsApp messages (text, images, audio, video, documents, stickers and locations) are turned into messages in a gateway conversation, and the sender is matched to an existing contact by phone number or created as a guest.
  • Outgoing messages and attachments are sent to WhatsApp; supported file types are limited and unsupported ones are refused. Delivery failures reported by WhatsApp are recorded on the message notification.
  • A new WhatsApp Templates screen lets users create message templates with header, body, footer, variables and buttons (URL, phone number, quick reply). Templates can be exported to WhatsApp, synchronised back, and imported in bulk from the gateway. Rules limit the number of buttons and require variables to be numbered without gaps.
  • A WhatsApp composer wizard and a Send WhatsApp button let users send a message or a template from a record, filling template variables from the record's fields.
  • Server actions gain a WhatsApp message option, so a template can be sent automatically to a contact when an action runs on a mail-enabled record.
  • A WhatsApp gateway configuration form holds the account, phone number, version and security key, and shows the number of templates.

Depends on

mail_gatewayphone_validation
Models and fields (10)
  • mail.thread · extends an existing model
  • res.partner · new model
  • mail.gateway · extends an existing modelgateway_type, whatsapp_version, whatsapp_account_id, whatsapp_from_phone, whatsapp_security_key, whatsapp_template_ids, whatsapp_template_count
  • ir.actions.server · extends an existing modelstate, whatsapp_partner, whatsapp_gateway_id, whatsapp_template_id
  • whatsapp.composer · new modelbody (Message), res_id (Document ID), res_model (Document Model Name), gateway_id, template_id, find_gateway, number_field_name, is_required_template
  • mail.gateway.whatsapp · new model
  • mail.whatsapp.template · new modelbody, name, model (Related model), state, footer, header, category, language, model_id (Applies to), button_ids (Buttons), company_id, gateway_id, is_supported, template_uid, variable_ids (Variables), template_name
  • mail.compose.gateway.message · extends an existing modelwhatsapp_template_id
  • mail.whatsapp.template.button · new modelname (Button Text), sequence, url_type, button_type (Type), call_number, template_id, website_url, variable_ids
  • mail.whatsapp.template.variable · new modelname (Placeholder), model (Model Name), button_id, line_type, field_name (Field), template_id, sample_value

Text generated by AI (DeepSeek) from reading the Odoo 18.0 code on GitHub; it may contain mistakes, so check the code before deciding. The module is very large and only part of the code was read. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 3 confirmed, 6 with no information of 9 versions.

terminal Installation and usage

OCA documentation · Odoo 18.0

Configuration

Source · Odoo 18.0

First steps

You need to create a WhatsApp Business Account (WABA), a Meta App and define a phone number. You can follow this steps.

If you create a test Business Account, passwords will change every 24 hours.

In order to make the webhook accessible, the system must be public.

Configure the gateway

Once you have created the Meta App, you need to add the gateway and webhook. In order to make it you must follow this steps:

  • Access Settings \> Emails \> Mail Gateway
  • Create a Gateway of type WhatsApp

> - Use the Meta App authentication key as Token field > - Use the Meta App Phone Number ID as Whatsapp from Phone field > - Use the Meta Account Business ID as Whatsapp account field (only if > you need sync templates) > - Write your own Webhook key > - Use the Application Secret Key on Whatsapp Security Key. It will be > used in order to validate the data > - Press the Integrate Webhook Key. In this case, it will not integrate > it, we need to make it manually > - Copy the webhook URL

  • Access Facebook Apps website
  • Access your App then Whatsapp \> Configuration
  • Create your webhook using your URL and put the Whatsapp Security Key as validation Key
  • Administer the Webhook and activate the messages webhook

Usage

Source · Odoo 18.0
  • Access Gateway
  • Wait until someone starts a conversation.
  • Now you will be able to respond and receive messages to this person.

No verified information in OCA: Installation.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.