telecmi / piopiy_example_python

PIOPIY Webhook implementation example in python

PIOPIY Webhook Python

PIOPIY webhooks implementation in python. Use our simple python web server to test your webhooks and live events locally for development purpose.

Install

Follow the below installation instructions

Prerequisites

Prerequisites for python web server.

• git (>= 2.20.1 required)
• python (>= 2.7.16 required)
• pip (>= 18.1 required)

Clone the repository

Use command git clone to clone the python webserver from our PIOPIY github repository.

git clone https://github.com/telecmi/piopiy_example_python.git

Change the directory to your project directory

cd piopiy_example_python

Install flask package using pip

Use command pip to install the flask(lightweight web application framework).

pip install flask # shows the tagged versions

Run

Run your python server using the below command

python webhooks.py

Now you can able to test our webhooks and live events, from your local server. To expose your local web server to the internet use ngrok.

You can create a secure HTTP tunnel by providing the port number on which your web server is running. For example, your web server is running on port number 5000. you can launch your HTTP tunnel with the following command line.

./ngrok http 5000

After exposing your local webserver to the internet using ngrok you will get the following output.

ngrok by @inconshreveable                                       (Ctrl+C to quit)
                                                                                
Session Status                online                                            
Session Expires               7 hours, 59 minutes                               
Update                        update available (version 2.3.35, Ctrl-U to update
Version                       2.3.34                                            
Region                        United States (us)                                
Web Interface                 http://127.0.0.1:4040                             
Forwarding                    http://c654b286.ngrok.io -> http://localhost:5000 
Forwarding                    https://c654b286.ngrok.io -> http://localhost:5000
                                                                                
Connections                   ttl     opn     rt1     rt5     p50     p90       
                              0       0       0.00    0.00    0.00    0.00  

Now you can get your dynamic URL from the above output. To configure webhooks and live events, paste your dynamic URL with correct path in webhooks section.

Sample URL with path

http://c654b286.ngrok.io/webhook/cdr