whatsapp-api-webhook-server-python-v2 0.1.1

This library helps you easily create a Python server endpoint to receive WhatsApp message webhooks.

whatsapp-api-webhook-server-python-v2

Support links

Guides & News

• Документация на русском языке.

whatsapp-api-webhook-server-python-v2 is a library for receiving and processing webhooks from green-api.com, based on FastAPI server.

You should get a registration token and an account ID in your personal cabinet to use the library. To develop, you can use a free account with the "Developer" tariff.

API

The documentation for the REST API can be found at the link. The library is a wrapper for the REST API, so the documentation at the link above also applies.

Authorization

To send a message or perform other Green API methods, the WhatsApp account in the phone app must be authorized. To authorize the account, go to your cabinet and scan the QR code using the WhatsApp app.

Examples of preparing the environment

Example of preparing the environment for Ubuntu Server

Updating the system

Update the system:

sudo apt update
sudo apt upgrade -y

Firewall

Set up the firewall:

Allow the SSH connection:

sudo ufw allow ssh

Base rules:

sudo ufw default deny incoming
sudo ufw default allow outgoing

Allow HTTP and HTTPS connections:

sudo ufw allow http
sudo ufw allow https

Enable the firewall:

sudo ufw enable

Installation

A package management system must be installed:

sudo apt install python3-pip

Library installation:

python3 -m pip install whatsapp-api-webhook-server-python-v2

As an example you can download and run our script:

wget https://raw.githubusercontent.com/green-api/whatsapp-api-webhook-server-python-v2/master/examples/receive_all_with_counter.py

python3 -m receive_all_with_counter.py

Example of preparing the environment for Windows Server

Python installation

Python must be installed on the server. Python installation instructions.

How to configure web server

To use IIS (Internet Information Services) as a web server, you need to configure the configuration file web.config so that the IIS service can properly execute Python code. This file is located in the publication folder of your web server.

After installing the interpreter, you should define the HttpPlatform handler in the web.config file. This handler will transfer connections to the standalone Python process.

Example configuration file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <system.webServer>
        <handlers>
            <add name="PythonHandler" path="*" verb="*" modules="httpPlatformHandler" resourceType="Unspecified"/>
        </handlers>
        <httpPlatform arguments="<Path-to-server-file>\receive_all_with_counter.py.py"
                      processesPerApplication="16"
                      processPath="<Path-to-python>\python.exe"
                      startupTimeLimit="60"
                      stdoutLogEnabled="true"
                      stdoutLogFile="<Path-to-log-file>\python.log">
            <environmentVariables>
                <environmentVariable name="SOME_VARIABLE" value="%SOME_VAR%"/>
            </environmentVariables>
        </httpPlatform>
    </system.webServer>
</configuration>

• <Path-to-python> - the path to the executable file of the Python interpreter;
• <Path-to-server-file> - the path to the server executable file (e.g. receive_all_with_counter.py from the example);
• <Path-to-log-file> - the path to the log file.

You will also need to open the corresponding port to the external network by setting the firewall settings (Advanced Options -> Rules for incoming connections -> Create Rule -> Rule Type = Port Protocols, Port -> TCP, specify the firewall settings. options -> Rules for incoming connections -> Create Rule -> Rule Type = Port, Protocols and Port -> TCP, specify port, Action -> Allow connection).

How to run example via Docker

The machine should have Docker installed.

To get an image from the Docker Hub, you need to write a command:

sudo docker pull greenapi/whatsapp-api-webhook-server-python-v2

Run the image in a container with the port and the console displayed:

sudo docker run -it -e PORT=8000 -p 80:8000 greenapi/whatsapp-api-webhook-server-python-v2

In this case we run a webhook server on 8000 port inside container and proxy our machine's 80 port to internal 8000 container's port

In personal cabinet you will need to specify the IP (or external machine name) with this (80) port.

After the container is launched, the data on incoming webhooks will be available in the console.

Also you can run it via docker compose (from root repo directory):

docker compose up --build

Running the server

To use in your solutions, simply import the GreenAPIWebhookServer class and init server object.

from whatsapp_api_webhook_server_python_v2 import GreenAPIWebhookServer

def event_handler(webhook_type: str, webhook_data: dict):
    # Write webhook handling logic here
    ...

handler = GreenAPIWebhookServer(
    event_handler=event_handler,    # Your event handler func (check examples in repo)
    host="0.0.0.0",                 # Your host
    port=8080,                      # Your port
    webhook_auth_header=None,       # Webhook auth header param (check API console)
)

if __name__ == "__main__":
    handler.start()

The event_handler parameter is a handler function that should be created by the developer.

Method parameters:

Parameter	Description
webhook_type: str	type of incoming webhook
webhook_data: dict	data of incoming webhook

Example: receive_all_with_counter.py.

Also, if you need to implement webhooks processing logic inside your project yourself, you can use Pydantic v2 models, which are located in the webhook_dto.py file

How to reroute incoming notifications to a web server

To reroute incoming notifications, you need to set the notification sending address (URL) in personal cabinet.

Service methods documentation

Service methods documentation

License

Licensed under Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0) terms. Please see file LICENSE.