https://github.com/telexintegrations/customer-feedback-api
https://github.com/telexintegrations/customer-feedback-api
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/telexintegrations/customer-feedback-api
- Owner: telexintegrations
- Created: 2025-02-22T11:21:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-22T11:52:00.000Z (over 1 year ago)
- Last Synced: 2025-02-22T12:28:00.502Z (over 1 year ago)
- Language: Python
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Customer Feedback API
A Flask-based API for collecting and managing customer complaints and reviews. This application integrates with **Telex** to provide real-time updates on customer feedback.
## Features
- Submit customer complaints/reviews via a web form.
- Fetch all complaints in JSON format.
- Telex integration for real-time updates.
- Secure endpoints with API keys and tokens.
## Project Structure
complaint-monitor/
├── app/
│ ├── init.py
│ ├── routes/
│ │ └── complaints.py
│ ├── services/
│ │ └── complaint_service.py
│ └── config.py
│ ├── models/
│ └── complaint.py
├── templates/
│ └── index.html
├── requirements.txt
├── .env
├── wsgi.py
└── README.md
## Setup Instructions
### 1. Clone the Repository
git clone https://github.com/VirusEmp/customer-feedback-api.git
cd customer-feedback-api
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install requirements
pip install -r requirements.txt
# Run the application
python wsgi.py
API Endpoints
1. Submit a Complaint
URL: /
Method: POST
Description: Submit a customer complaint/review.
Form Fields:
name (optional): Customer name.
complaint (required): Complaint/review text.
2. Fetch All Complaints
URL: /all
Method: GET
Description: Fetch all submitted complaints in JSON format.
3. Telex Integration
URL: /complaints_data
Method: GET
Description: Fetch complaints data for Telex integration.
Query Parameter(token): Telex secret token. #which is gotten after integrating app with telex
4. Telex Settings
URL: /telex_settings
Method: GET
Description: Fetch Telex integration settings in JSON format.
Telex Integration
This application integrates with Telex to provide real-time updates on customer complaints. The integration includes:
Tick URL: Fetches complaints data at regular intervals.
Target URL: Sends formatted data to Telex's webhook.