Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kneckter/WebhookListener
A python and flask application to receive and log webhooks
https://github.com/Kneckter/WebhookListener
Last synced: 2 months ago
JSON representation
A python and flask application to receive and log webhooks
- Host: GitHub
- URL: https://github.com/Kneckter/WebhookListener
- Owner: Kneckter
- Archived: true
- Created: 2019-06-23T16:39:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-23T22:26:13.000Z (over 2 years ago)
- Last Synced: 2024-08-02T01:16:27.195Z (6 months ago)
- Language: Python
- Size: 594 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-rainmana - Kneckter/WebhookListener - A python and flask application to receive and log webhooks (Python)
README
# WebhookListener (Moved to GitLab)
A python and flask application to receive and log webhooks. If they are webhooks from PoGo++ or iSpoofer, it will also decode them.
## Installation
### Requirements
Install the following:
* python3
* python3-pip
* git
Verify version using:
```
$ python3 --version
Python 3.6.7
$ pip3 --version
pip 9.0.1 from /home/pogo/python3-test/lib/python3.6/site-packages (python 3.6)
```
This also requires a webhook source, which is not provided. If the webhooks are from PoGo++ or iSpoofer, you can also use options to decode them.
### Downloading the Application
To run a copy from the latest develop branch in git you can clone the repository:
`git clone https://github.com/Kneckter/WebhookListener`
### Installing Modules
Open up your shell (cmd.exe/terminal.app) and change to the directory of WebhookListener.
Install the Python dependencies with the following command:
Windows:
`pip3 install -U -r requirements.txt`
Linux/OSX:
`sudo -H pip3 install -U -r requirements.txt`
### Basic Launching
Start the application with the following command:
`python3 runserver.py`
You can display the optional parameters by using the `--help` flag. No webhook data will be displayed unless at least one logging option is set. All options can be set on the command line or in the `./conf/config.ini` file. If you setup a `config.ini` file, the program will read the settings automatically without specifying it in the command line.
Once your setup is running, open your browser to http://localhost:5000/webhook and you should see text displaying `Listening for webhooks`.
## Integration
If you are running an NGINX reverse proxy for your main webhook receiver, you can setup a mirror so you do not need to change your webhook generating application. Below is an example of how to setup the server block in NGINX.
```
server {
listen 9002;
server_name 127.0.0.1;
location / {
mirror /mirror;
proxy_pass http://127.0.0.1:9001;
access_log off;
error_log /dev/null;
}
location /mirror {
internal;
proxy_pass http://127.0.0.1:5000/webhook;
access_log off;
error_log /dev/null;
}
}
```