https://github.com/telexintegrations/freshdesk-notifications-telex-integration
https://github.com/telexintegrations/freshdesk-notifications-telex-integration
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/telexintegrations/freshdesk-notifications-telex-integration
- Owner: telexintegrations
- License: mit
- Created: 2025-02-22T10:20:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-22T15:30:38.000Z (over 1 year ago)
- Last Synced: 2025-02-22T15:47:26.645Z (over 1 year ago)
- Language: JavaScript
- Size: 1000 Bytes
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FRESHDESK TELEX INTEGRATION
This project is an interation for [Telex](telex.im) that fetches new ticket notification from Freshdesk and sends it to a telex channel. It is built using Nodejs(express) and designed to connect to your freshdesk application easily
## Features
- Sends Freshdesk ticket notification to telex channel.
- Webhook url to connect to your company's freshdesk account.
- Customizable interval for receiving notifications.
## Setup (local) Instructions
To run this locally, ensure you have the following installed:
- Node.js
- npm
- Express
### Steps
1. Clone the repository:
```sh
git clone https://github.com/telexintegrations/freshdesk-notifications-telex-integration.git
cd freshdesk-notifications-telex-integration
```
2. Install dependencies
```sh
npm install
```
3. Create a .env file and specify a port
```sh
PORT = 5000
API_KEY = 123456789
FRESHDESH_DOMAIN = your-domain.com
```
4. Start the server
```sh
npm start
```
5. Run tests
```
npm test
```
6. See integration spec file in your browser or with postman
```sh
http://localhost:5000/integration-spec
```
## API ENDPOINTS
### Base Url
```
https://freshdesk-notifications-telex-integration.onrender.com
```
### Integration Specifications
`GET/${base_url}/integtation-spec` - This end point returns a json specififcations for the integation
### Tick Endpoint
`POST/${base_url}/tick` - this endpoint is called at interval by telex, it fetches the notification from freshdesk and send to the telex channel
## Integration Settings
- `API key` - your company's freshdesk api key
- `Freshdesk Domain` - your company freshdesk domain
## How to test this integration
If you do not have a freshdesk account a default freshdesk api key and domain name has been added during deployment on render
- leave api key and freshdesk domain empty
- set an interval at default its 1min
- To get notified create a ticket on [Freshdesk](https://nwabueze2amarachi.freshdesk.com/support/tickets/new) and get notified on telex
## screenshot of the freshdesk integration in a telex channel
