{"id":26678287,"url":"https://github.com/telexintegrations/telex-feedback-integration","last_synced_at":"2025-03-26T05:15:23.470Z","repository":{"id":278975442,"uuid":"937358123","full_name":"telexintegrations/telex-feedback-integration","owner":"telexintegrations","description":"Tracks customer feedback form submissions","archived":false,"fork":false,"pushed_at":"2025-02-22T22:37:39.000Z","size":18115,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-22T23:22:46.238Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/telexintegrations.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-22T22:01:12.000Z","updated_at":"2025-02-22T22:37:42.000Z","dependencies_parsed_at":"2025-02-22T23:32:54.501Z","dependency_job_id":null,"html_url":"https://github.com/telexintegrations/telex-feedback-integration","commit_stats":null,"previous_names":["telexintegrations/telex-feedback-integration"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Ftelex-feedback-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Ftelex-feedback-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Ftelex-feedback-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telexintegrations%2Ftelex-feedback-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telexintegrations","download_url":"https://codeload.github.com/telexintegrations/telex-feedback-integration/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245591533,"owners_count":20640692,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-26T05:15:22.893Z","updated_at":"2025-03-26T05:15:23.458Z","avatar_url":"https://github.com/telexintegrations.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Feedback Form Monitoring Integration\n\nThis integration tracks customer feedback form submissions from Google Forms and automatically sends notifications to a specified Telex channel.\n\n## Features\n- Fetches form responses from a Google Sheets backend.\n- Processes feedback submissions in real time.\n- Sends notifications to Telex for monitoring.\n- Supports manual and automated data processing.\n\n## Prerequisites\nEnsure you have the following before setting up the integration:\n- Node.js installed on your machine.\n- A Google Sheet linked to a Google Form for storing responses.\n- A Telex webhook URL for sending notifications.\n- API credentials for Google Sheets.\n\n## Setup Instructions\n1. **Clone the repository:**\n   ```sh\n   git clone https://github.com/telexintegrations/telex-feedback-integration.git\n   cd telex-feedback-integration\n   ```\n\n2. **Install dependencies:**\n   ```sh\n   npm install\n   ```\n\n3. **Create a `.env` file** in the project root and add the following:\n   ```env\n   PORT=3000\n   SHEET_ID=your_google_sheet_id\n   GOOGLE_API_KEY=your_google_api_key\n   ```\n\n4. **Run the integration:**\n   ```sh\n   node index.js\n   ```\n\n## API Endpoints\n### Fetch Feedback Data\n**GET `/api/telex/data`**\n- Retrieves feedback responses from Google Sheets.\n- **Response:**\n  ```json\n  {\n    \"data\": [\n      {\n        \"timestamp\": \"2025-02-22\",\n        \"feedback\": \"Great service!\"\n      }\n    ]\n  }\n  ```\n\n### Process Feedback Manually\n**POST `/api/telex/tick`**\n- Manually triggers processing and sends feedback data to Telex.\n- **Response:**\n  ```json\n  {\n    \"message\": \"Tick received, feedback processed!\"\n  }\n  ```\n\n## Automated Processing\n- The integration fetches new responses from Google Sheets every 60 seconds and sends them to Telex automatically.\n\n## Testing\nRun tests using Jest:\n```sh\nnpm test\n```\n\n### Test Cases\n- Verify that form responses are correctly retrieved from Google Sheets.\n- Ensure feedback messages are successfully sent to Telex.\n- Confirm API endpoints return the expected responses.\n\n## Screenshots\nExample notification received in the Telex channel:\n![Telex Channel Notification](screenshots/telex_notification.png)\n\n## Quick Test\n- Fill a feedback form [here](https://forms.gle/LRWZU2VegVwiXWcF9)\n- Confirm your response(s) [here](https://docs.google.com/spreadsheets/d/1d6tldVy6N-i5EwHtlkxvc5yxG1HN3S84no0bFH-wdzw/edit?usp=sharing)\n- The application will send new data to the Telex channel at the interval of 60 seconds OR you can manually initiate on Postman with this POST URL: https://telex-feedback-integration.onrender.com/tick\n- Check the Test channel ```#feedback-notifications``` on the telex-integration-test-3 organization for notifications\n\n## License\nThis project is open-source and available under the MIT License.\n\n## Contributions\nFeel free to open issues or submit pull requests for improvements!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelexintegrations%2Ftelex-feedback-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelexintegrations%2Ftelex-feedback-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelexintegrations%2Ftelex-feedback-integration/lists"}